From 78cf337edfab886c6969a324894183b9bb4a8cde Mon Sep 17 00:00:00 2001
From: Dmitry <b4tm4n@mail.ru>
Date: Sun, 25 Feb 2024 23:00:34 +0300
Subject: [PATCH] upd README + docs

---
 README.md  | 36 ++++++++++++++++++++++++++++++------
 mkdocs.yml |  4 ++--
 2 files changed, 32 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 8aad26e..ead3d68 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,23 @@
 
 Возможно `DDNS` клиент
 
-## запуск
+## Запуск
 
 ~~~sh
 python -m pddnsc.cli
 ~~~
 
-## конфигурация
+либо в [docker](https://www.docker.com)/[podman](https://podman.io) (для запуска по расписанию в `cron`):
+
+~~~bash
+docker build -t my/pddnsc .
+docker run -v .state:/app/state:rw \
+           -v .settings:/app/settings:ro \
+           -e SCHEDULE=@hourly \
+           my/pddnsc
+~~~
+
+## Конфигурация
 
 Конфигурация находится в файле `settings/config.toml`.
 Пример конфигурации:
@@ -27,7 +37,7 @@ python -m pddnsc.cli
     filepath = "state/hash.txt"
 
 [outputs]
-  # сохранение хеша всех ip адресов в файл, 
+  # сохранение хеша всех ip адресов в файл,
   # чтобы потом проверить изменились ли они
   [outputs.hash-file]
     provider = "StateHashFile"
@@ -36,7 +46,7 @@ python -m pddnsc.cli
   # сервис доменов на vscale (vds.selectel.ru)
   # токен в переменной окружения VSCALE_API_TOKEN
   [outputs.vscale]
-    provider = "VscaleDomains" 
+    provider = "VscaleDomains"
     domain = "example.com"
     target = "www" # изменяем www.example.com
     ttl = 3600
@@ -52,6 +62,20 @@ python -m pddnsc.cli
 
 Все модули источников/фильтров/вывода работают конкурентно через `asyncio`.
 
-### TODO
+### Подробная документация
 
-- Добавить названия python классов и их параметры.
+Её необходимо собрать с помошью [mkdocs](https://www.mkdocs.org). Для этого нужно установить зависимости:
+
+~~~bash
+pip install -r requirements.txt
+pip install -r requirements.docs.txt
+~~~
+
+После этого либо собрать документацию в каталог `site/`, либо запустить тестовый сервер.
+
+~~~bash
+# сборка
+mkdocs build
+# тестовый сервер
+mkdocs serve
+~~~
diff --git a/mkdocs.yml b/mkdocs.yml
index 7175611..983a5a1 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -20,5 +20,5 @@ plugins:
       config: mkapi_conf.py
 
 nav:
-  - Home: index.md
-  - Reference: $api/pddnsc.***
+  - Главная: index.md
+  - Справочник: $api/pddnsc.***