diff --git a/README.md b/README.md index 2cd120f..35c9ed5 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,37 @@ ![Eremos](docs/banner2.png) +

+ + Stars + + + Open Issues + + + License + + + PRs Welcome + +

+ **Autonomous swarm agents for early on-chain signal detection** Eremos is a lightweight framework for deploying modular agents that monitor blockchain activity - tracking wallet clusters, mint patterns, and contract anomalies. Designed for devs who want low-noise, early signals embedded into their workflows. --- +## Table of Contents +- [Features](#features) +- [Example Signal](#example-signal) +- [Signal Confidence](#signal-confidence) +- [Tech Stack](#tech-stack) +- [Getting Started](#getting-started) +- [Key Folders](#key-folders) +- [Contributing](#contributing) +- [License](#license) +- [Links](#links)

Agent Theron
@@ -112,9 +137,11 @@ npm run dev ## Contributing We’re open to contributors. -If you are experienced in TypeScript and like agent-based systems, check `example.ts` and build your own observer. +If you are experienced in TypeScript and like agent-based systems, check example.ts and build your own observer. If you're a designer, artist, or just have ideas that fit the mythos - send us a DM on Twitter. [@EremosCore](https://x.com/EremosCore) +πŸ‘‰ See our [Contributing Guide](CONTRIBUTING.md) for details. + --- ## License diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..c23333d --- /dev/null +++ b/contributing.md @@ -0,0 +1,16 @@ +# Contributing to Eremos + +First off, thanks for taking the time to contribute πŸ’› +Eremos is an open framework, and small improvements add up to a big difference for developers and researchers. + +--- + +## How to Contribute + +### 1. Fork & Clone +- Fork the repo on GitHub +- Clone your fork locally: + ```bash + git clone https://github.com/YOUR-USERNAME/Eremos.git + cd Eremos + npm install \ No newline at end of file