Feat: Added README.md

This commit is contained in:
minhtrannhat 2022-08-18 09:45:41 -04:00
parent 6348ec8fb6
commit 756e934e93
No known key found for this signature in database
GPG Key ID: 894C6A5801E01CA9

16
README.md Normal file
View File

@ -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.