ав46

README.md

@@ -1,3 +1,44 @@
-# debweb
+## debweb
 
-webserver для дебилов
+**debweb** - простой webserver для дебилов (for me) на асинхронных сокетах
+
+## установка и настройка
+
+debweb использует всего одну стороннюю библиотеку - aiofiles. ее можно установить с помощью
+
+```bash
+pip install aiofiles
+```
+> [!IMPORTANT]
+конфигурация сия шедевра происходит с помощью env (переменных окружения). из обязательных - `PRESET_FILE` и `DIR`
+
+### сеть
+
+- `ADDR` - адрес сервера (по умолчанию - `localhost`)
+- `PORT` - порт сервера (по умолчанию - `7856`)
+
+### файлы и директории
+
+- `FILE` - файл логов (по умолчанию вывод в консоль)
+- `PRESET_FILE` - файл пресета (подробнее ниже)
+- `DIR` - рабочая директория
+
+### буферы
+
+- `READ_BUFFER` - буфер для запроса (по умолчанию - `16384`)
+- `WRITE_BUFFER` - размер чанка при отправке файлов (по умолчанию - `16384`)
+
+### логи
+
+- `START_MSG` - лог при старте сервера (по умолчанию - `started at <ADDR>`)
+- `CONN_MSG` - лог при подключении (по умолчанию - `conn from <ADDR>`)
+- `GET_MSG` - лог при GET запросе (по умолчанию - `<ADDR> got <FILE>`) 
+- `404_MSG` - лог при ошибке 404 (по умолчанию - `<ADDR> err 404 <FILE>`)
+
+`<ADDR>` будет заменен на адрес клиента
+
+`<FILE>` будет заменен на файл / директорию
+
+## preset
+
+файл пресета - обычный html документ. но в нем нужно указать тег <FILES> для отображения файлов в директории. кастомизируй на здоровье!