From d97e4d49441ca3a20f05249a699860e91e28f688 Mon Sep 17 00:00:00 2001
From: mirivlad <mirivlad@gmail.com>
Date: Fri, 21 Nov 2025 23:17:22 +0800
Subject: [PATCH] add readme

---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d6e5a61
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# Web Writer
+
+**Лицензия:** AGPLv3  
+
+**Web Writer** — веб-приложение для написания, хранения и публикации книг и серий книг. Поддерживает Markdown с расширением для диалогов, автосохранение текста, экспорт и управление пользователями.
+
+---
+
+## 🚀 Возможности
+
+- **Книги и серии:** создавайте серии и добавляйте книги с главами.  
+- **Редактор книг:** Markdown, автосохранение текста, интерактивное содержание.  
+- **Предпросмотр книг:**
+  - **Автор:** видит все черновики и опубликованные главы.  
+  - **Публичный доступ:** только опубликованные главы по ссылке с `shared_token`.  
+- **Обложки и аватары:** добавляйте изображения к книгам и профилям.  
+- **Экспорт:** PDF, DOCX, HTML, TXT.  
+- **Администрирование пользователей:**  
+  - Управление аккаунтами, активация/деактивация.  
+  - При удалении пользователя удаляются все его книги.  
+- **Публичные ссылки:** делитесь `shared_token` для просмотра опубликованных глав.
+
+---
+
+## ⚙️ Требования
+
+- **PHP:** 8.0 и выше  
+- **MySQL** с InnoDB и внешними ключами  
+- **PHP расширения:** `mbstring`, `json`, `PDO`  
+- Веб-сервер с правами на запись в папки `config/` и `uploads/`  
+
+> Все библиотеки уже включены в `vendor/`. Composer не нужен.
+
+---
+
+## 🛠 Установка
+
+1. Скопируйте файлы на веб-сервер.  
+2. Проверьте доступность папок `config/` и `uploads/` для записи.  
+3. Перейдите в браузере на `install.php` и следуйте шагам:  
+
+   **Шаг 1: Настройки базы данных**  
+   - Хост БД  
+   - Имя базы данных  
+   - Пользователь и пароль  
+
+   **Шаг 2: Создание администратора**  
+   - Имя пользователя  
+   - Пароль  
+   - Email (по желанию)  
+   - Отображаемое имя (по желанию)
+
+4. После успешной установки файл `config/config.php` будет сгенерирован автоматически.  
+5. Перейдите на главную страницу приложения (`index.php`) и войдите под админом.
+6. **Не забудьте удалить или переместить файл install.php!!!**
+
+---
+
+## 📝 Конфигурация
+
+Файл `config/config.php` содержит:
+
+- Подключение к базе данных: `DB_HOST`, `DB_USER`, `DB_PASS`, `DB_NAME`  
+- Пути к файлам:
+  - `UPLOAD_PATH` — корневая папка загрузок  
+  - `COVERS_PATH` / `COVERS_URL` — обложки книг  
+  - `AVATARS_PATH` / `AVATARS_URL` — аватары пользователей  
+- Адрес сайта: `SITE_URL`  
+- Имя приложения: `APP_NAME` = "Web Writer"
+
+---
+
+## 🛠 Дальнейшее развитие
+
+- Планирую вынести работу с сущностями (книги, главы, серии, пользователи) в контроллеры.  
+- Создать единую точку входа для приложения.
+
+---
+
+## ❗ Поддержка
+
+Все ошибки и предложения шлите в issue
+
+---
+
+## 📜 Лицензия
+
+Приложение распространяется под лицензией [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html).
\ No newline at end of file