Skip to content

docs: Added Table of Contents and Contributing Guide #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Chefash wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Added Table of Contents and Contributing Guide #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36237fa
Added CONTRIBUTING.md and linked it from README
Chefash Aug 16, 2025
60a2d9a
docs: Added Table of Contents and Contributing Guide
Chefash Aug 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,37 @@

![Eremos](docs/banner2.png)

<p align="center">
<a href="https://github.com/EremosCore/Eremos/stargazers">
<img src="https://img.shields.io/github/stars/EremosCore/Eremos?style=for-the-badge" alt="Stars" />
</a>
<a href="https://github.com/EremosCore/Eremos/issues">
<img src="https://img.shields.io/github/issues/EremosCore/Eremos?style=for-the-badge" alt="Open Issues" />
</a>
<a href="https://github.com/EremosCore/Eremos/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/EremosCore/Eremos?style=for-the-badge" alt="License" />
</a>
<a href="https://github.com/EremosCore/Eremos/pulls">
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen?style=for-the-badge" alt="PRs Welcome" />
</a>
</p>

**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)

<p align="center">
<img src="docs/therontphd2.png" alt="Agent Theron" width="155"/><br/>
Expand Down Expand Up @@ -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
Expand Down
16 changes: 16 additions & 0 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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