diff --git a/README.md b/README.md index 6e049ef..0a9f21e 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,82 @@ -## debweb +# debweb **debweb** - простой webserver для дебилов (for me) на асинхронных сокетах -## установка и настройка +# установка и настройка debweb использует всего одну стороннюю библиотеку - aiofiles. ее можно установить с помощью ```bash pip install aiofiles ``` -> [!IMPORTANT] + конфигурация сия шедевра происходит в файле `config.py` -### основное +## основное - `name` - название сервера, отображается в http заголовках +- `proxied` - указывает, находится ли сервер за прокси -### сеть +## сеть - `addr` - адрес сервера - `port` - порт сервера -### файлы и директории +## файлы и директории - `log_file` - файл логов (по умолчанию вывод в консоль) -- `preset_file` - файл пресета. обычный html документ. но в нем нужно указать одиночный тег `` для отображения файлов в директории -- `directory` - рабочая директория **обязательно с / на конце!!!!** +- `preset_file` - файл пресета +- `directory` - рабочая директория -### буферы +## буферы -- `read_buffer` - буфер для запроса +- `read_buffer` - размер буфера для запросов - `write_buffer` - размер буфера при отправке файлов -### логи +## логи - `start_msg` - лог при старте сервера - `conn_msg` - лог при подключении - `get_msg` - лог при GET запросе -`` будет заменен на адрес клиента +## теги -`` будет заменен на файл / директорию, к которой запрашивается доступ +- `` - адрес клиента +- `` - файл / директория, к которой запрашивается доступ +- `