diff --git a/README.md b/README.md index 981289c..aae80e3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# Swear-Jar---Discord-Bot +# Swear Jar -Simple Swear Jar Discord Bot \ No newline at end of file +Swear Jar is a Discord application that records how often selected words appear in chat messages. +It is designed as a light‑weight 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 per‑user and per‑guild 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 re‑enable data tracking. +- Periodic status update that displays the global total of detected words. + +--- + +## ⚙️ Technical Overview +- Language: **Python 3.11+** +- Library: **discord.py 2.4+** +- Database: **SQLite (`swearjar.db`)** +- Gateway Intents: + - `message_content`: **enabled** + - `guilds`: **enabled** + - `members`: **disabled** + - `presences`: **disabled** + +Data stored: \ No newline at end of file