summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorn1c00o <n@nc0.fr>2023-02-06 22:24:33 +0100
committerNicolas <34602094+n1c00o@users.noreply.github.com>2023-02-06 22:35:54 +0100
commite656ab8e1a03955c45552d06b211b43183e94793 (patch)
treecfd793b65ff3a238260158ea6f7cc40b4cf72820
parente4b54d66140a68b083e1c63d10a78a335a2c6050 (diff)
Update documentation
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 51d8182..c95f6f0 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,30 @@ The system can accept a maximum of **2^7 = 128 machines** for a given epoch.
## Usage
-TODO(nc0): Usage information, with or without containers.
+Before launching any worker, you need to determine the following information:
+
+- `epoch`: corresponds to the epoch workers will be using to generate IDs.
+- `machine`: the identifier for the machine.
+
+Due to the format of a Clawflake, you can only have 128 workers (machine IDs
+between 0 and 127).
+
+You can compile the worker by running `make generator`.
+This will generate an executable named `generator` inside the `bin/` directory.
+
+You can then start the worker by running:
+
+```shell
+export MACHINE_ID= # Worker ID, between 0 and 127
+export EPOCH= # Epoch to use in ID generation
+./bin/generator -machine_id=$MACHINE_ID -epoch=$EPOCH -grpc_host=":5000"
+```
+
+> Use the flag `-help` to view the documentation for the flags.
+
+A worker should be running on port `5000`. You can try generating some
+Clawflake ID numbers using the [Generator API](api/nc0/clawflake/generator/v3).
+A test client is available in [`cmd/testclient`](cmd/testclient/main.go).
## License