Skip to content

Commit 7c62ff9

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

1 file changed

Lines changed: 18 additions & 23 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
11
# spreader-agent
2-
A TypeScript agent for spreading and managing instances.
32

4-
## What it does
5-
Automates deployment, monitoring, and scaling of instances across environments as part of the **Cocapn Fleet** (SuperInstance org).
3+
**TypeScript** agent for the Cocapn Fleet (github.com/SuperInstance). It spreads data across nodes efficiently.
64

7-
## Installation
5+
## 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.
7+
8+
## Usage
89
```bash
10+
# Clone
911
git clone https://github.com/SuperInstance/spreader-agent.git
1012
cd spreader-agent
13+
14+
# Install
1115
npm ci
12-
```
1316

14-
## Usage
15-
1. Configure settings in `src/config.ts` or via environment variables.
16-
2. Run the agent:
17-
```bash
18-
npm run start
19-
```
20-
3. Run the test suite:
21-
```bash
22-
npm test
23-
```
17+
# Build
18+
npm run build
2419

25-
## Scripts
26-
- `npm run build` – compile TypeScript.
27-
- `npm run lint` – lint source files.
20+
# Run (example)
21+
npm start # or `node dist/index.js`
22+
```
2823

29-
## Documentation
30-
- [BOOTCAMP.md](BOOTCAMP.md) – onboarding guide.
31-
- [CHARTER.md](CHARTER.md) – project charter.
32-
- [DOCKSIDE-EXAM.md](DOCKSIDE-EXAM.md) – exam documentation.
24+
## 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
3328

3429
## License
35-
See [LICENSE](LICENSE) for details.
30+
MIT – see [LICENSE](LICENSE).

0 commit comments

Comments
Β (0)