README.md aktualisiert

README.md

@@ -1,48 +1,91 @@
-## Civita Discord Bot
 
-Modular Discord.js v14 bot with MariaDB storage, Gemini AI, profanity filter, XP system, and slash commands.
+<img alt="Civita Banner" src="https://github.com/user-attachments/assets/86e0fc72-9d74-4e21-a911-cd5d2a556f90" />
 
-### Requirements
+Civita is a **Discord moderation and AI-powered bot** built to make communities safe, fun, and engaging.  
-- Node.js 18.17+
+With smart **profanity filters**, an **AI assistant**, and an automated **Question of the Day (QOTD)** system powered by AI, Civita combines powerful moderation with next-gen AI interaction.  
-- pnpm 8+
-- MariaDB 10.5+
 
-### Environment
+---
-Create a `.env` file in the project root with:
 
-```
+## What civita means?
-DISCORD_TOKEN=
+On a good day Civita means “city,” “state,” or “citizenship.” from Latin, on
-DISCORD_CLIENT_ID=
+a bad day, it means Idiotic Truckload of Shit
-GEMINI_API_KEY=
-DATABASE_HOST=127.0.0.1
-DATABASE_PORT=3306
-DATABASE_USER=root
-DATABASE_PASSWORD=changeme
-DATABASE_NAME=civita
-```
 
-### Install
+## ✨ Features
+- 🔧 **Moderation Tools**
+  - Kick, ban, mute, warn
+  - Automated profanity filtering
+  - Reaction-based reporting
+- 🤖 **AI Assistant**
+  - Chat with Civita using AI
+  - Smart responses and server-friendly interaction
+- 📝 **AI-Powered QOTD**
+  - Automatically generates interesting questions
+  - Keeps your community engaged daily
+- 📢 **Community Tools**
+  - Welcome/leave messages
+
+---
+
+## 📦 Installation
+
+### Prerequisites
+- [Node.JS](https://nodejs.org/en)  
+- [PnPm](https://pnpm.io/) (or NPM but not recommended)  
+- A [Discord Bot Token](https://discord.com/developers/applications)  
+- An Gemini API key
+
+### Setup
 ```bash
+# Clone the repository
+git clone https://git.optimihost.com/NaChlorid/Civita.git
+cd Civita
+
+# Install dependencies
 pnpm install
-```
 
-### Deploy Commands
+# Run the bot
-```bash
+pnpm run start
-pnpm deploy
+````
-```
 
-### Run (dev)
+---
-```bash
-pnpm dev
-```
 
-### Features
+## ⚙️ Configuration
-- `/setup` to enable/disable: moderation, ai, logs, qotd, profanity_filter
-- `/leaderboard`, `/profile`
-- `/ban`, `/kick`, `/timeout`
-- Profanity filter (toggle via `/setup`)
-- Bot answers when mentioned if AI enabled
-- Daily QOTD if enabled and channel set
-- Status updates to: watching (N) servers
 
+1. Rename `.example.env` to `.env`
+2. Fill in your bot token, API keys, and preferences
 
+---
+
+## 📖 Documentation
+
+https://civita.optimihost.com/docs
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+* Fork the repo
+* Create a feature branch
+* Submit a pull request
+
+Please follow the [Security Policy](SECURITY.md) when reporting vulnerabilities.
+
+---
+
+## 🔒 Security
+
+See [SECURITY.md](SECURITY.md) for supported versions and reporting guidelines.
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 💡 Credits
+
+Developed with ❤️ by **OptimiDev** and contributors.