diff --git a/README.md b/README.md index 1b526dc..2ad953f 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,12 @@ # smalltalk -## running server +very lightweight voice communicator written in Rust -### using docker +***Don't use this project for secret conversations as it don't use encryption yet!*** -```bash -docker build -t smalltalk . -docker run -d --rm -p 6767:6767/tcp -p 6767:6767/udp --name smalltalk smalltalk -``` +## Client -### using cargo - -before, open port `6767` tcp and udp - -Usage: - -```bash -cargo run -p server --release -- [OPTIONS] -``` - -Options: - -``` --s, --server-ip [default: 0.0.0.0:6767] --h, --help Print help --V, --version Print version -``` - -## build and run client - -Usage: +### run using cargo ```bash cargo run -p client --release -- --server-ip @@ -42,3 +19,28 @@ Options: -h, --help Print help -V, --version Print version ``` + +## Server + +### run using docker + +```bash +docker build -t smalltalk . +docker run -d --rm -p 6767:6767/tcp -p 6767:6767/udp --name smalltalk smalltalk +``` + +### run using cargo + +before, open port `6767` tcp and udp + +```bash +cargo run -p server --release -- [OPTIONS] +``` + +Options: + +``` +-s, --server-ip [default: 0.0.0.0:6767] +-h, --help Print help +-V, --version Print version +```