Update README.md

This commit is contained in:
2025-12-23 17:59:59 +00:00
parent 01f843dc33
commit 67fd33aff6

View File

@@ -1,3 +1,30 @@
# Swear-Jar---Discord-Bot
# SwearJar
Simple Swear Jar Discord Bot
SwearJar is a Discord application that records how often selected words appear in chat messages.
It is designed as a lightweight statistics tool, not a moderation bot.
All commands use the Interactions (slash command) API through [discord.py](https://github.com/Rapptz/discord.py).
---
## 📄Features
- Tracks peruser and perguild counters for configured words.
- Updates totals automatically when a message contains one or more tracked words.
- `/swearjar` — show personal and total counts.
- `/sweartop` — leaderboard of top users per server or global.
- `/swearwords` — view the most frequently detected words.
- `/privacy` — view, delete, or reenable data tracking.
- Periodic status update that displays the global total of detected words.
---
## ⚙TechnicalOverview
- Language: **Python3.11+**
- Library: **discord.py2.4+**
- Database: **SQLite (`swearjar.db`)**
- GatewayIntents:
- `message_content`: **enabled**
- `guilds`: **enabled**
- `members`: **disabled**
- `presences`: **disabled**
Data stored: