mini-chat/README.md

40 lines
933 B
Markdown

# mini-chat
Tiny IRC-like chat server written in Go
<p align="center">
<img width="90%" height="90%" src="https://git.bulgariu.xyz/raul/mini-chat/raw/branch/main/demo.gif"/>
</p>
## Commands
### Client
```
Example:
./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")
```