Skip to content

Commit 414d319

Browse files
committed
docs(readme): update readme and add links to documentation parts
1 parent 0e9ce23 commit 414d319

1 file changed

Lines changed: 61 additions & 23 deletions

File tree

README.md

Lines changed: 61 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,84 @@
1-
[discord-shield]: https://img.shields.io/discord/1407300551686885418?color=5865F2&logo=discord&logoColor=white
1+
<p align="center">
2+
<img src="https://github.com/Rustmail/rustmail/blob/main/docs/static/logo.svg?raw=true" width="200" alt="Rustmail">
3+
</p>
24

3-
[discord-invite]: https://discord.gg/9Bzma6SwtW
5+
<h1 align="center">Rustmail</h1>
46

5-
<div align="center">
6-
<img src="https://github.com/Akinator31/rustmail/blob/main/docs/static/logo.svg?raw=true" width="250" alt="Rustmail Logo">
7-
</div>
7+
<p align="center">
8+
A modern Discord modmail bot written in Rust
9+
</p>
810

9-
# Rustmail - Discord Modmail Bot (Rust)
10-
11-
[ ![discord-shield][] ][discord-invite]
11+
<p align="center">
12+
<a href="https://discord.gg/9Bzma6SwtW"><img src="https://img.shields.io/discord/1407300551686885418?color=5865F2&logo=discord&logoColor=white&label=Discord" alt="Discord"></a>
13+
<a href="https://github.com/Rustmail/rustmail/releases"><img src="https://img.shields.io/github/v/release/Rustmail/rustmail?label=Release" alt="Release"></a>
14+
<a href="https://github.com/Rustmail/rustmail/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Rustmail/rustmail?label=License" alt="License"></a>
15+
</p>
1216

1317
---
14-
A Discord modmail bot written in Rust that allows staff to manage support tickets via channels, with features like
15-
message editing, internationalization, structured error handling, and more.
16-
The bot can operate in single-server or dual-server modes, supports SQLite for data storage, and offers a range of
17-
commands for staff to interact with users efficiently.
18+
19+
## Overview
20+
21+
Rustmail is a Discord modmail bot that enables staff teams to manage support tickets through private channels. Users send direct messages to the bot, which creates dedicated channels for staff to respond and track conversations.
22+
23+
### Key Features
24+
25+
- **Dual-server or single-server mode** - Separate community and staff servers, or run everything on one server
26+
- **Web administration panel** - Manage tickets, configuration, and permissions through a browser
27+
- **Message editing and deletion** - Full control over ticket messages with change tracking
28+
- **Scheduled closures and reminders** - Automate ticket management workflows
29+
- **Multi-language support** - 10 languages available (EN, FR, ES, DE, IT, PT, RU, ZH, JA, KO)
30+
- **REST API** - Integrate with external tools and automation
1831

1932
---
2033

21-
## ⚠️ Warning ⚠️
34+
## Quick Start
35+
36+
### 1. Generate your configuration
37+
38+
Use the online configurator to create your `config.toml` file:
2239

23-
This is my first major project in Rust; while I have solid experience in C and other languages, I'm learning Rust as I
24-
go — feedback and PRs are welcome.
40+
**[config.rustmail.rs](https://config.rustmail.rs)**
2541

26-
Project documentation is currently being written.
42+
The configurator guides you through all required settings and generates a ready-to-use configuration file.
43+
44+
### 2. Download and run
45+
46+
Download the latest release for your platform from [Releases](https://github.com/Rustmail/rustmail/releases), then:
47+
48+
```bash
49+
# Place config.toml in the same directory as the executable
50+
./rustmail
51+
```
52+
53+
The bot creates its SQLite database automatically on first run.
2754

2855
---
2956

30-
## Getting Started
57+
## Documentation
3158

32-
- 🛠️ [Setting up the bot](https://github.com/Rustmail/rustmail/tree/main/docs/setup.md)
33-
- 📦 [Commands](https://github.com/Rustmail/rustmail/tree/main/docs/commands.md)
59+
| Section | Description |
60+
|---------|-------------|
61+
| [Installation](docs/getting-started/installation.md) | Download and setup instructions |
62+
| [Configuration](docs/getting-started/configuration.md) | Detailed configuration guide |
63+
| [Commands](docs/guides/commands.md) | Complete command reference |
64+
| [Server Modes](docs/guides/server-modes.md) | Single vs dual-server setup |
65+
| [Web Panel](docs/guides/panel.md) | Administration panel guide |
66+
| [API Reference](docs/reference/api.md) | REST API documentation |
67+
| [Docker Deployment](docs/deployment/docker.md) | Container deployment |
68+
| [Architecture](docs/development/architecture.md) | Technical overview |
69+
70+
Full documentation is available in the [docs](docs/) directory.
3471

3572
---
3673

3774
## Support
3875

39-
If you need help, join the [Discord server][discord-invite] and ask for assistance in the #support channel.
76+
For help and discussions, join the [Discord server](https://discord.gg/9Bzma6SwtW).
77+
78+
---
4079

4180
## License
4281

43-
This project is licensed under the [AGPLv3 License](https://github.com/Rustmail/rustmail/blob/main/LICENSE).
82+
This project is licensed under the [AGPLv3 License](LICENSE).
4483

45-
> **Note:** The `rustmail-panel` i18n module includes code derived from [i18n-rs](https://github.com/opensass/i18n-rs),
46-
> which is licensed under the MIT License.
84+
The `rustmail_panel` i18n module includes code derived from [i18n-rs](https://github.com/opensass/i18n-rs), licensed under MIT.

0 commit comments

Comments
 (0)