Skip to content

Commit 9b301f2

Browse files
clean up readme
1 parent fe613a3 commit 9b301f2

1 file changed

Lines changed: 25 additions & 75 deletions

File tree

README.md

Lines changed: 25 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,25 @@
1-
# DevScout 🔍
1+
# DevScout
22

3-
**Ethereum open-source intelligence agent** — built with [ElizaOS v2](https://elizaos.ai) and powered by [Nosana](https://nosana.io) decentralised GPU compute.
3+
Ethereum OSINT agent that helps developers find contribution-ready issues across major protocol clients. Built with ElizaOS v2, runs on Nosana's decentralised GPU network.
44

5-
DevScout helps developers find high-quality contribution opportunities across major Ethereum protocol clients, reports live chain health, and explains GitHub issues with difficulty estimates.
5+
## What it does
66

7-
---
7+
**Find issues to work on** — scans 5 Ethereum repos (Lodestar, Lighthouse, Alloy, Reth, go-ethereum) for `good first issue` and `help wanted` labels. Filter by language if you only write Rust, TypeScript, or Go.
88

9-
## What DevScout Can Do
9+
**Check chain health** — pulls live gas price, beacon epoch, and participation rate from public RPCs and beaconcha.in.
1010

11-
### 1. Scan for Contribution-Ready Issues
12-
DevScout searches 5 major Ethereum repositories for `good first issue` and `help wanted` tickets:
11+
**Explain issues** — paste a GitHub issue URL and get a plain-language summary with a difficulty estimate and suggested approach.
1312

14-
| Repository | Language | Client Type |
13+
## Repos it watches
14+
15+
| Repository | Language | Type |
1516
|---|---|---|
1617
| [ChainSafe/lodestar](https://github.com/ChainSafe/lodestar) | TypeScript | Consensus |
1718
| [sigp/lighthouse](https://github.com/sigp/lighthouse) | Rust | Consensus |
1819
| [alloy-rs/alloy](https://github.com/alloy-rs/alloy) | Rust | Libraries |
1920
| [paradigmxyz/reth](https://github.com/paradigmxyz/reth) | Rust | Execution |
2021
| [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum) | Go | Execution |
2122

22-
Filter by language: *"Show me Rust issues"* or *"Find TypeScript good first issues"*
23-
24-
### 2. Live Ethereum Network Status
25-
```
26-
Gas Price: 12.34 Gwei
27-
Beacon Epoch: 321,456
28-
Participation Rate: 99.2%
29-
```
30-
Sourced from `ethereum.publicnode.com` and `beaconcha.in`.
31-
32-
### 3. Issue Summariser
33-
Paste any GitHub issue URL and DevScout will:
34-
- Summarise the problem in plain language
35-
- Estimate difficulty (beginner / intermediate / advanced)
36-
- Suggest how to approach the fix
37-
38-
---
39-
40-
## Quick Start
41-
42-
### Prerequisites
43-
- [Bun](https://bun.sh) runtime
44-
- [ElizaOS CLI](https://elizaos.ai/docs/cli): `npm install -g @elizaos/cli`
45-
- A [Nosana](https://nosana.io) API key (for Qwen3.5 inference)
46-
- GitHub Personal Access Token (optional, for higher rate limits)
47-
48-
### Setup
49-
50-
```bash
51-
git clone https://github.com/TechFusionData/eth-devscout.git
52-
cd eth-devscout
53-
bun install
54-
cp .env.example .env
55-
# Edit .env with your Nosana API key and GitHub token
56-
```
57-
58-
### Run
59-
60-
```bash
61-
bun run start
62-
# or for development with hot reload:
63-
bun run dev
64-
```
65-
66-
---
67-
6823
## Architecture
6924

7025
```
@@ -80,34 +35,29 @@ ElizaOS Runtime
8035
└─► SUMMARIZE_ISSUE (GitHub Issues API → plain-language summary)
8136
```
8237

83-
All inference runs on **Nosana's decentralised GPU network** using `Qwen3.5-27B-AWQ-4bit`.
84-
85-
---
38+
Inference runs on Nosana GPUs using Qwen3.5-27B-AWQ-4bit.
8639

87-
## Tech Stack
40+
## Setup
8841

89-
- **ElizaOS v2** — agent framework
90-
- **Nosana** — decentralised GPU inference (Qwen3.5-27B-AWQ-4bit)
91-
- **GitHub REST API v3** — issue discovery
92-
- **ethereum.publicnode.com** — free Ethereum RPC
93-
- **beaconcha.in** — beacon chain explorer API
94-
- **TypeScript** — type-safe plugin code
95-
- **Bun** — fast JS runtime
42+
Needs [Bun](https://bun.sh) and [ElizaOS CLI](https://elizaos.ai/docs/cli) (`npm install -g @elizaos/cli`).
9643

97-
---
44+
```bash
45+
git clone https://github.com/TechFusionData/eth-devscout.git
46+
cd eth-devscout
47+
bun install
48+
cp .env.example .env
49+
# Add your Nosana API key and (optionally) GitHub token for higher rate limits
50+
bun run start
51+
```
9852

99-
## Nosana Builders Challenge
53+
## Stack
10054

101-
This agent is submitted to the [Nosana Builders Challenge](https://earn.superteam.fun/listing/nosana-builders-challenge)*Build an ElizaOS v2 AI agent that runs on Nosana's GPU network.*
55+
ElizaOS v2 · Nosana GPU (Qwen3.5-27B) · GitHub REST API v3 · ethereum.publicnode.com · beaconcha.in · TypeScript · Bun
10256

103-
The challenge rewards agents that demonstrate:
104-
- ✅ Real utility (contribution discovery for Ethereum developers)
105-
- ✅ Live data integration (chain status, GitHub API)
106-
- ✅ ElizaOS v2 plugin architecture
107-
- ✅ Deployment on Nosana GPU infrastructure
57+
## Context
10858

109-
---
59+
Built for the [Nosana Builders Challenge](https://earn.superteam.fun/listing/nosana-builders-challenge) — the prompt was to build an ElizaOS v2 agent running on Nosana infrastructure. I wanted something with actual utility for Ethereum contributors rather than another chatbot wrapper, so this focuses on reducing the friction of finding a good first PR across the ecosystem.
11060

11161
## License
11262

113-
MIT © TechFusionData
63+
MIT

0 commit comments

Comments
 (0)