aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranciszek Malinka <franciszek.malinka@gmail.com>2023-09-27 00:18:51 +0200
committerFranciszek Malinka <franciszek.malinka@gmail.com>2023-09-27 00:18:51 +0200
commit18c360e93e13de7c732afbb9df54ccc4fc2c726a (patch)
tree6812cfc981ed12cb688fcb6586c073dd31ddae71
parent39c539b046be423b3acc68c5a3de216060d7dde3 (diff)
Add usage section in readmeHEADmain
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index ec26f63..b466a92 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,15 @@ between client and the server.
I've learned this stuff during my Jane Streets internship this year. I'll probably use
this repository as a handy example for my future OCaml code.
+
+## Usage
+
+To run the server, run from the root directory:
+
+ $ dune exec -- ./server/bin/server.exe -log-level debug
+ [INFO] ("Spinning up server"(where_to_listen((socket_type((family PF_INET)(socket_type SOCK_STREAM)))(address 0.0.0.0:8080)(listening_on <opaque>))))
+
+To make a call, run the client:
+
+ $ dune exec -- ./client/bin/client.exe hello-world "Ciao" "Franek"
+ Ciao, Franek!