Dev branch beginning with a bunch of shit added. All I know is that it builds.
This commit is contained in:
36
README.md
36
README.md
@ -8,8 +8,12 @@ A high-performance Slack bot written in Go that automatically tracks Wordle scor
|
||||
- 📊 **Daily Summaries**: Posts a configurable morning summary of yesterday's results
|
||||
- 🏆 **Leaderboard**: Shows who solved the puzzle and their scores
|
||||
- 📈 **Statistics**: Calculates success rate and average scores
|
||||
- 🔥 **Streaks**: Track individual and group solve streaks
|
||||
- 📅 **Weekly Reports**: View the last 7 days of results
|
||||
- 👤 **Personal Stats**: See your own average, win rate, and distribution
|
||||
- 🛡️ **Anti-Cheat**: Validates puzzle numbers and prevents duplicate submissions
|
||||
- ⚙️ **Configurable**: Set custom summary times and channels
|
||||
- ✅ **Reaction Confirmation**: Adds a checkmark reaction when it tracks a score
|
||||
- 💬 **Thread Replies**: Replies with updated standings when you post a score
|
||||
- 🚀 **High Performance**: Written in Go for minimal resource usage
|
||||
|
||||
## Quick Start
|
||||
@ -26,11 +30,13 @@ This project follows standard Go project layout:
|
||||
- `internal/` - Private application packages (bot, config, tracker)
|
||||
- `pkg/` - Public library code (reusable pattern matching)
|
||||
|
||||
See [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) for detailed documentation.
|
||||
|
||||
### Build and Run
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://git.ewnix.net/phlux/slack-wordle-scores.git
|
||||
git clone <your-repo-url>
|
||||
cd wordle-bot
|
||||
|
||||
# Download dependencies and generate go.sum
|
||||
@ -47,7 +53,7 @@ export SLACK_APP_TOKEN="xapp-your-app-token"
|
||||
./wordle-bot
|
||||
```
|
||||
|
||||
Or use the included Makefile:
|
||||
Or use the included Makefile (handles `go mod tidy` automatically):
|
||||
|
||||
```bash
|
||||
make build
|
||||
@ -157,8 +163,15 @@ Wordle 1662 5/6
|
||||
|
||||
The bot will automatically:
|
||||
- Detect the score
|
||||
- Validate the puzzle number (must be today's puzzle ±1 day for timezones)
|
||||
- Check for duplicates (only one score per person per day)
|
||||
- Track it for daily summary
|
||||
- Add a ✅ reaction to confirm
|
||||
- **Reply in thread** with confirmation and updated standings
|
||||
|
||||
**Anti-Cheat Reactions:**
|
||||
- Thread reply with ✅ = Score accepted and tracked (includes today's standings)
|
||||
- ❌ reaction = Invalid puzzle number (not today's Wordle)
|
||||
- 🔁 reaction = Duplicate (you already posted today)
|
||||
|
||||
### Slash Commands
|
||||
|
||||
@ -172,6 +185,21 @@ The bot will automatically:
|
||||
/wordle-stats yesterday
|
||||
```
|
||||
|
||||
**View last 7 days:**
|
||||
```
|
||||
/wordle-stats week
|
||||
```
|
||||
|
||||
**View all-time leaderboard:**
|
||||
```
|
||||
/wordle-stats leaderboard
|
||||
```
|
||||
|
||||
**View your personal stats (with streaks!):**
|
||||
```
|
||||
/wordle-stats me
|
||||
```
|
||||
|
||||
**Configure summary time:**
|
||||
```
|
||||
/wordle-config time 09:00
|
||||
|
||||
Reference in New Issue
Block a user