diff --git a/README.md b/README.md index d1c7166..028c3e6 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,34 @@ Tiny IRC-like chat server written in Go

-## Usage examples -### Starting the server: -./mini-chat server --port 1337 --history chat.log --password verysecurepassword +## Commands +### Client +``` +Example: + ./mini-chat client --ip 192.168.0.100 --port 1337 -### Connecting to the server: -./mini-chat client --ip 192.168.0.100 --port 1337 +Usage: + mini-chat client [flags] + +Flags: + -h, --help help for client + --insecure [UNSAFE] Do not use TLS encryption + -i, --ip string Server IP to connect to + -p, --port string Server port to connect to (default "1302") +``` + +### Server +``` +Example: + ./mini-chat server --port 1337 + +Usage: + mini-chat server [flags] + +Flags: + -h, --help help for server + -r, --history string File to store and recover chat history from + --insecure [UNSAFE] Do not use TLS encryption + --password string Password for accessing the chat server + -p, --port string port to use for listening (default "1302") +```