Обновление документации

LICENSE

@@ -1,6 +1,6 @@
 MIT No Attribution
 
-Copyright 2024 Alexander Popov
+Copyright 2025 Alexander Popov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software

README.md

@@ -1,3 +1,81 @@
-# TODO
+---
+gitea: none
+include_toc: true
+---
+
+# 🎴 Бот для ведения статистики клана в AniCard
+
+## 📦 Возможности
+
+- [ ] Сохранение статистики побед в КВ членов клана
+- [ ] Сохранение статистики пожертвований в сокровищницу членов клана
+
+
+## 💽 Установка и использование
+
+### 📄 Подготовка файла конфигурации
+
+Настройки приложения хранится в файле `.env`.
+Пример файла с настройками называется `env.example`.
+
+```sh
+cp env.example .env
+```
+
+Разбор файла настроек:
+
+- `APP_ID`  — Идентификатор приложения Telegram.
+- `APP_HASH` — Хэш  приложения Telegram.
+- `ACCOUNT` — Имя аккаунта пользователя Telegram (_например `db_o_qp`_).
+- `LOG_PATH` — Путь в файлу логов (_например `/tmp/test.log`_).
+- `DB_PATH` — Путь к файлу базы данных SQLite3 (_например `./db.sqlite`_).
+
+
+### 🐦‍🔥 Настройка виртуального окружения и загрузка бибилотек
+
+Создание и активация виртуального окружения.
+
+```sh
+python3 -m venv venv
+. ./venv/bin/activate
+```
+
+Установка библиотек.
+
+```sh
+pip3 install -r requirements.txt
+```
+
+
+### ▶️ Первый запуск
+
+В время первого запуска появится запрос данных авторизации от библиотеки `Pyrogram`.
+
+```text
+Welcome to Pyrogram (version 2.0.106)
+Pyrogram is free software and comes with ABSOLUTELY NO WARRANTY. Licensed
+under the terms of the GNU Lesser General Public License v3.0 (LGPL-3.0).
+
+Enter phone number or bot token: 898********
+Is "898********" correct? (y/N): y
+The confirmation code has been sent via Telegram app
+Enter confirmation code: 14628
+```
+
+
+### 🧤 Systemd
+
+> ⚠️ В процессе написания...
+
+
+# 📑 TODO
 
 - [ ] Добавить уведомления, если что-то пошло не так
+
+
+# 💼 Используемые библиотеки
+
+- **Pyrogram** — Telegram клиент
+- **python-dotenv** — Работа с `.env` файлами
+- **loguru** — Логирование
+- **black** — Форматирование кода

pyproject.toml

@@ -1,3 +1,18 @@
+[project]
+dynamic = [ "version" ]
+name = "..."
+description = "..."
+authors = [ {name = "Alexander Popov", email = "iiiypuk@fastmail.fm"}, ]
+readme = "README.md"
+license = { text = "MIT-0 License" }
+dependencies = [ ]
+requires-python = ">= 3.8"
+
+classifiers=[ 'License :: OSI Approved :: MIT No Attribution License (MIT-0)', ]
+
+[project.urls]
+Changelog = "https://change.me//CHANGELOG.md"
+
 [tool.black]
-line-length = 123
-skip-string-normalization = 1
+skip-string-normalization = true
+line-length = 132