Building out the README a bit.

2019-12-20 14:53:57 +00:00
parent 234bf7d0a0
commit 1954895e16
1 changed files with 19 additions and 2 deletions
@@ -1,2 +1,19 @@
-# nym-mixnode
-A Rust mixnode implementation
+# Nym Mixnode
+
+A Rust mixnode implementation.
+
+## Building
+
+* check out the code
+* install rust (stable)
+* `cargo build --release` (for a production build)
+
+The built binary can be found at `target/release/nym-mixnode`
+
+## Usage
+
+* `nym-mixnode` prints a help message showing usage options
+* `nym-mixnode run --help` prints a help message showing usage options for the run command
+* `nym-mixnode run --layer 1` will start the mixnode in layer 1 (coordinate with other people to find out which layer you need to start yours in)
+
+By default, the Nym Mixnode will start on port 1789. If desired, you can change the port using the `--port` option.