Skip to content

Commit 4b810d4

Browse files
committed
[docs] Add README
1 parent 7c62ff9 commit 4b810d4

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# spreader-agent
22

3-
**TypeScript** agent for the Cocapn Fleet (github.com/SuperInstance). It spreads data across nodes efficiently.
3+
**TypeScript** agent for efficient data spreading, part of the **Cocapn Fleet** (github.com/SuperInstance).
44

55
## Description
6-
A lightweight, test‑driven library that handles data distribution, integrates with the fleet’s messaging layer, and provides a clear API for developers.
6+
Spreader Agent handles high‑throughput data distribution and processing within the Cocapn Fleet. Built with TypeScript, it integrates seamlessly with the fleet’s other services and runs on Groq’s LPU hardware for fast AI inference.
77

88
## Usage
99
```bash
10-
# Clone
10+
# Clone the repo
1111
git clone https://github.com/SuperInstance/spreader-agent.git
1212
cd spreader-agent
1313

14-
# Install
15-
npm ci
14+
# Install dependencies
15+
npm install
1616

17-
# Build
17+
# Build the project
1818
npm run build
1919

20-
# Run (example)
21-
npm start # or `node dist/index.js`
20+
# Run the agent
21+
npm start
2222
```
2323

2424
## Related
25-
- [Cocapn Fleet](https://github.com/SuperInstance) – the ecosystem this agent belongs to
26-
- [BOCAMP.md](BOCAMP.md) – onboarding guide
27-
- [DOCKSIDE-EXAM.md](DOCKSIDE-EXAM.md) – testing criteria
25+
- **Cocapn Fleet**https://github.com/SuperInstance
26+
- **Groq LPU**https://groq.com
27+
28+
## Contributing
29+
See [CHARTER.md](CHARTER.md) for contribution guidelines.
2830

2931
## License
30-
MIT – see [LICENSE](LICENSE).
32+
Distributed under the terms of the [LICENSE](LICENSE).

0 commit comments

Comments
 (0)