Skip to content

Commit 91354d5

Browse files
committed
chore: update README.md for version 1.1.0; add new documentation links, improve command descriptions, and enhance project structure details
1 parent b266a95 commit 91354d5

1 file changed

Lines changed: 25 additions & 15 deletions

File tree

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Многофункциональный Discord бот с системой уровней, модерацией, автомодерацией, тикетами, временными голосовыми каналами и другими полезными функциями.
44

5+
**Версия:** 1.1.0
6+
57
![Preview png](https://i.imgur.com/4mcFuzQ.png)
68

79
## Основные функции
@@ -39,6 +41,8 @@
3941
- Конфигурация: [docs/configuration.md](docs/configuration.md:1)
4042
- FAQ: [docs/faq.md](docs/faq.md:1)
4143
- Миграция: [docs/migration.md](docs/migration.md:1)
44+
- История изменений: [docs/CHANGELOG.md](docs/CHANGELOG.md:1)
45+
- Тесты: [docs/tests.md](docs/tests.md:1)
4246

4347
## Установка и запуск
4448

@@ -47,6 +51,7 @@
4751
- Python 3.10 или выше
4852
- Redis (опционально, для кэширования)
4953
- PostgreSQL (опционально, по умолчанию используется SQLite)
54+
- MongoDB (опционально, для расширенного хранилища)
5055

5156
### Установка
5257

@@ -58,7 +63,7 @@
5863

5964
2. Установите зависимости:
6065
```
61-
uv pip install -e .[dev]
66+
uv pip install -e ".[dev]"
6267
```
6368

6469
3. Создайте файл `data/.env`:
@@ -119,14 +124,15 @@
119124

120125
### Автомодерация
121126

122-
- `/automod addword` - Добавить запрещенное слово
123-
- `/automod removeword` - Удалить запрещенное слово
124-
- `/automod listwords` - Список запрещенных слов
125-
- `/automod setspam` - Установить порог спама
126-
- `/automod setinterval` - Установить интервал спама
127-
- `/automod setmentions` - Установить лимит упоминаний
128-
- `/automod setwarnings` - Установить максимум предупреждений
129-
- `/automod setmute` - Установить длительность мута
127+
- `/automod` - Настройка автомодерации (параметры: action, value)
128+
- `action=addword` - Добавить запрещенное слово
129+
- `action=removeword` - Удалить запрещенное слово
130+
- `action=listwords` - Список запрещенных слов
131+
- `action=setspam` - Установить порог спама
132+
- `action=setinterval` - Установить интервал спама
133+
- `action=setmentions` - Установить лимит упоминаний
134+
- `action=setwarnings` - Установить максимум предупреждений
135+
- `action=setmute` - Установить длительность мута
130136

131137
### Тикеты
132138

@@ -160,15 +166,19 @@ mee6/
160166
├── assets/ # Шрифты и ресурсы
161167
├── data/ # .env, JSON конфиги, база
162168
├── docs/ # Документация
169+
├── plans/ # Планы разработки
163170
├── src/ # Исходный код
164-
│ ├── app/
165-
│ ├── application/
166-
│ ├── cogs/
167-
│ ├── infrastructure/
168-
│ └── ...
171+
│ ├── app/ # Точка входа и DI-контейнер
172+
│ ├── application/ # Контракты сервисов
173+
│ ├── cogs/ # Команды и события Discord
174+
│ ├── database/ # Модели и подключение к БД
175+
│ ├── domain/ # Бизнес-логика
176+
│ ├── infrastructure/# Репозитории, конфиги, кэш, мониторинг
177+
│ ├── presentation/ # Коги для UI (automod, moderation)
178+
│ └── utils/ # Вспомогательные функции
169179
├── tests/ # Тесты
170180
├── bot.py # Точка входа
171-
└── pyproject.toml # Зависимости и метаданные
181+
└── pyproject.toml # Зависимости и метаданные
172182
```
173183

174184
## Лицензия

0 commit comments

Comments
 (0)