diff --git a/README.md b/README.md index 763f018..b79dac3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,41 @@ # smalltalk +## build and run client + +Usage: + +```bash +cargo run -p client --release -- --server-ip +``` + +Options: + +``` +-s, --server-ip +-h, --help Print help +-V, --version Print version +``` + +## build and run server + +before, open port `8080` tcp/udp + +Usage: + +```bash +cargo run -p server --release -- [OPTIONS] +``` + +Options: + +``` +-s, --server-ip [default: 0.0.0.0:8080] +-h, --help Print help +-V, --version Print version +``` + +--- + I think it will be based on: - `tokio`: async and network connection @@ -7,17 +43,3 @@ I think it will be based on: - `opus`: encoding and decoding audio stream - `ffmpeg-next`: capturing, encoding and decoding video stream - `egui` + `eframe`: ui - -## running client - -```bash -cargo run -p client -``` - -## running server - -open port `8080` tcp/udp and run - -```bash -cargo run -p server -```