diff --git a/README.md b/README.md new file mode 100644 index 0000000..0adff40 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# MINH_CORD + +A wannabe discord clone but currently only support websocket real time chatting + +## Dependencies +- `rust` +- `telnet` + +## Installation +- Run `cargo build` at project root to build the binary. + +## Running +- Run the server with `cargo run` or `RUST_LOG=info cargo run` to run with debug. + +## Connecting to the server +- If server is running on localhost, run `telnet 127.0.0.1 8080` to connect to the server.