Explorar el Código

added version0 run commands to readme

rachel-rose hace 5 años
padre
commit
e42cd9ffb0
Se han modificado 1 ficheros con 42 adiciones y 0 borrados
  1. 42 0
      README.md

+ 42 - 0
README.md

@@ -1,5 +1,47 @@
 Not even an alpha product. Just a mere prototype(s).
 
+# darkfid usage
+
+To run darkfid:
+
+```console
+$ cargo run --bin darkfi
+```
+
+To run with verbose:
+
+```console
+$ cargo run --bin darkfi -- -v
+```
+
+*Run 10 clients simultaneously*
+
+```console
+$ cargo test test_ten_clients_simultaneously --bin darkfid
+```
+
+*Run Client A and send 9 slabs. Client B should receive 10 slabs from subscriber*
+
+```console
+$ cargo test test_subscriber --bin darkfid
+```
+
+# dark-client usage
+
+In a seperate terminal, cd to /scripts directory and run the dark-client.
+
+*Show usage manual*:
+
+```console
+$ /drk -h
+```
+
+*Say hello*:
+
+```console
+$ /drk -hi
+```
+
 Let's liberate people from the claws of big tech and create the democratic paradigm of technology.
 
 Self-defense is integral to any organism's survival and growth.