Skip to content

Commit a94ca84

Browse files
committed
docs: MotelyWorker pool quick start + link to Jammy README
Made-with: Cursor
1 parent 169a2f5 commit a94ca84

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,22 @@ This repository is the **MotelyJAML** fork (from [tacodiva/Motely](https://githu
1212
- **Motely.CLI** – Command-line interface (JAML/JSON filters, seed analysis)
1313
- **Motely.API** – Optional HTTP API and static UIs
1414
- **Motely.TUI** – Terminal UI (optional)
15+
- **Motely.DistributedWorker**`MotelyWorker` executable: claims blocks from a Jammy/Seed Finder **pool API** and submits results
1516
- **JamlFilters/** – Example and test JAML filter files
1617

18+
## Distributed worker → Jammy pool (`MotelyWorker`)
19+
20+
Connects to **`POST /api/search/helper`** on a deployed Jammy app (e.g. seedfinder.app). Requires an active distributed search on the server so there is work in the pool.
21+
22+
```bash
23+
# From this repo root
24+
dotnet run --project Motely.DistributedWorker/Motely.DistributedWorker.csproj -- --pool https://www.seedfinder.app
25+
```
26+
27+
Publish (AOT): `dotnet publish Motely.DistributedWorker/Motely.DistributedWorker.csproj -c Release -r linux-x64` (or `win-x64`). Run the `MotelyWorker` binary from the `publish` folder with the same `--pool` flag.
28+
29+
**`--threads`**, **`--worker-id`**, **`--filter`**, **`--local-db`**: see the **Community worker (`MotelyWorker`)** section in the **[Jammy README](https://github.com/OptimusPi/JAMMY#community-worker-motelyworker)** (consumer app docs).
30+
1731
## Quick start (CLI)
1832

1933
```bash

0 commit comments

Comments
 (0)