Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sxmon17 committed Apr 24, 2023
1 parent 2b35008 commit a0e33c6
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ A simple, asynchronous TCP-based chat server built using Rust, Tokio, and SQLite
- [x] Logging with log and env_logger 📝
- [x] Admin account with special privileges and commands 🛡️

## Commands 📜
- `/help` - List all available commands
- `/listusers` - List all users with their online/offline status and their role
- `/history [blank, username, all]` - Show msg history
- `/whisper <username> <message>` - Send a private message to a user
- `/changepw <old_password> <new_password>` - Change your password
- `/color <color_name>` - Change your username color
- `/admin <password>` - Become an admin
- `/ban <username>` - Ban a user
- `/unban <username>` - Unban a user
- `/mute <username>` - Mute a user
- `/unmute <username>` - Unmute a user
- `/quit` - Quit the chat


## Prerequisites 📚

- Rust (stable) and Cargo 🦀
Expand All @@ -27,7 +42,7 @@ A simple, asynchronous TCP-based chat server built using Rust, Tokio, and SQLite
To start the server download FerrumServe from the release page

``` bash
$ ~/ferrum-serve 127.0.0.1:6142
$ ~/ferrum-serve 127.0.0.1:6142 admin1234
```

### Connecting to the server 📡
Expand All @@ -42,8 +57,8 @@ $ telnet 127.0.0.1:6142
#### Clone the repository

``` bash
$ git clone https://github.com/yourusername/rust-tcp-chat-server.git
$ cd rust-tcp-chat-server
$ git clone https://github.com/FerrumLink/FerrumServe
$ cd FerrumServe
```

#### Build the project
Expand Down

0 comments on commit a0e33c6

Please sign in to comment.