Update documentation.

Upgrade to version 0.4.0.
MisterBourbaki · Dec 4, 2024 · 04bf81b · 04bf81b
1 parent 86cc798
commit 04bf81b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "minimal-federated-computing"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 repository = "https://github.com/MisterBourbaki/minimal-federated-computing"
 readme = "README.md"

diff --git a/README.md b/README.md
@@ -24,8 +24,20 @@ Then run
 (.venv) cargo run --bin mfc-server
 ```
 
-to launch the server, and in another termianl window
+to launch the server, and in another terminal window
 
 ```bash
-(.venv) cargo run --bin mfc-client
+(.venv) cargo run --bin mfc-client -- --dim-vec 10
+```
+
+To change the address on which the server listen, use the `--addr` flag:
+
+```bash
+(.venv) cargo run --bin mfc-server -- --addr "127.0.0.1:10000"
+```
+
+and
+
+```bash
+(.venv) cargo run --bin mfc-client -- --dim-vec 10 -- --addr "127.0.0.1:10000"
 ```