Update README.md

This commit is contained in:
raul 2024-05-14 10:05:02 +02:00
parent 6d15f303b7
commit e7aada9a2a
1 changed files with 30 additions and 5 deletions

View File

@ -6,9 +6,34 @@ Tiny IRC-like chat server written in Go
<img width="90%" height="90%" src="https://git.bulgariu.xyz/raul/mini-chat/raw/branch/main/demo.gif"/> <img width="90%" height="90%" src="https://git.bulgariu.xyz/raul/mini-chat/raw/branch/main/demo.gif"/>
</p> </p>
## Usage examples ## Commands
### Starting the server: ### Client
./mini-chat server --port 1337 --history chat.log --password verysecurepassword ```
Example:
### Connecting to the server:
./mini-chat client --ip 192.168.0.100 --port 1337 ./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")
```