readme update
Continuous integration / build (push) Successful in 29s
Continuous integration / Check (push) Successful in 28s
Continuous integration / Test Suite (push) Successful in 25s
Continuous integration / Rustfmt (push) Successful in 22s

This commit is contained in:
2026-10-30 21:04:53 +01:00
parent 17e8643b8d
commit 42f63118fa
+29 -27
View File
@@ -1,35 +1,12 @@
# smalltalk # 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 ## Client
docker build -t smalltalk .
docker run -d --rm -p 6767:6767/tcp -p 6767:6767/udp --name smalltalk smalltalk
```
### using cargo ### run using cargo
before, open port `6767` tcp and udp
Usage:
```bash
cargo run -p server --release -- [OPTIONS]
```
Options:
```
-s, --server-ip <SERVER_IP> [default: 0.0.0.0:6767]
-h, --help Print help
-V, --version Print version
```
## build and run client
Usage:
```bash ```bash
cargo run -p client --release -- --server-ip <SERVER_IP> cargo run -p client --release -- --server-ip <SERVER_IP>
@@ -42,3 +19,28 @@ Options:
-h, --help Print help -h, --help Print help
-V, --version Print version -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 <SERVER_IP> [default: 0.0.0.0:6767]
-h, --help Print help
-V, --version Print version
```