Skip to content

Commit 41cba9f

Browse files
committed
docs: update README with detailed features and quick start guide
- Expanded README to include comprehensive features of the Rust Commit Tracker. - Added quick start instructions for cloning, building, and running the application. - Included configuration details and requirements for setup.
1 parent 955e084 commit 41cba9f

1 file changed

Lines changed: 67 additions & 2 deletions

File tree

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,68 @@
1-
# 🦀 Rust Commit Tracker
1+
# Rust Commit Tracker
22

3-
A professional Rust application that monitors Facepunch's Rust game commits and sends notifications to Discord via webhooks.
3+
A reliable Discord bot that monitors Facepunch's Rust game commits and sends real-time notifications with SQLite persistence.
4+
5+
## Features
6+
7+
- **Real-time monitoring** - Tracks new commits from Facepunch's Rust repository
8+
- **Discord integration** - Rich embed notifications with commit details
9+
- **SQLite persistence** - Prevents duplicate notifications across restarts
10+
- **Auto-configuration** - Creates config file on first run
11+
- **Automatic cleanup** - Maintains database size with configurable retention
12+
13+
## Quick Start
14+
15+
1. **Clone and build**
16+
17+
```bash
18+
git clone https://github.com/kWAYTV/rust-commit-tracker.git
19+
cd rust-commit-tracker
20+
cargo build --release
21+
```
22+
23+
2. **First run** (creates config file)
24+
25+
```bash
26+
cargo run
27+
```
28+
29+
3. **Configure** - Edit `config.toml` with your Discord webhook URL
30+
31+
4. **Run**
32+
```bash
33+
cargo run
34+
```
35+
36+
## Configuration
37+
38+
The bot creates `config.toml` on first run:
39+
40+
```toml
41+
[discord]
42+
webhook_url = "YOUR_DISCORD_WEBHOOK_URL"
43+
bot_name = "Rust Commit Tracker"
44+
bot_avatar_url = "https://i.imgur.com/on47Qk9.png"
45+
46+
[monitoring]
47+
commits_url = "https://commits.facepunch.com/?format=json"
48+
check_interval_secs = 50
49+
50+
[database]
51+
url = "sqlite:commits.db"
52+
cleanup_keep_last = 1000
53+
```
54+
55+
## Requirements
56+
57+
- Rust 1.70+
58+
- Discord webhook URL
59+
60+
## Files
61+
62+
- `config.toml` - Configuration (auto-created)
63+
- `commits.db` - SQLite database (auto-created)
64+
- Both files are git-ignored for security
65+
66+
## License
67+
68+
MIT

0 commit comments

Comments
 (0)