mini-chat/README.md

41 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2024-03-29 08:59:03 +01:00
# mini-chat
2024-04-26 09:37:46 +02:00
Tiny IRC-like chat server written in Go
2024-04-01 12:26:19 +02:00
2024-05-07 11:00:42 +02:00
<p align="center">
2024-05-08 08:07:38 +02:00
<img width="90%" height="90%" src="https://git.bulgariu.xyz/raul/mini-chat/raw/branch/main/demo.gif"/>
2024-05-07 11:00:42 +02:00
</p>
2024-04-01 12:26:19 +02:00
2024-05-14 10:05:02 +02:00
## Commands
### Client
```
Example:
./mini-chat client --ip 192.168.0.100 --port 1337
2024-04-01 12:26:19 +02:00
2024-05-14 10:05:02 +02:00
Usage:
mini-chat client [flags]
Flags:
-a, --ascii Render UI in pure ASCII, might help with rendering issues
2024-05-14 10:05:02 +02:00
-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:
2024-05-14 15:59:23 +02:00
./mini-chat server --port 1337 --history chat.log --password coolh4x0r1337
2024-05-14 10:05:02 +02:00
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
2024-05-14 15:59:23 +02:00
-p, --port string Port to use for listening (default "1302")
2024-05-14 10:05:02 +02:00
```