Create README.md

README.md

@@ -0,0 +1,82 @@
+# Inbox Zero
+
+Динамические списки задач прямо в Obsidian: помечайте файлы тегами, просматривайте их в настраиваемом чек-листе и удаляйте без следа одним нажатием. Помогает держать хранилище в порядке и доводить количество активных заметок до нуля.
+
+## Возможности
+
+- **Поиск по тегам** — плагин находит все заметки в указанных папках, содержащие заданный `#тег` прямо в тексте (inline-теги). Frontmatter не требуется.
+- **Живые чек-листы** — файлы отображаются в виде списка с чекбоксами. Отметил галочку — файл безвозвратно удалён, а строка исчезает.
+- **Drag-and-drop с сохранением порядка** — перетаскивайте задачи мышкой, чтобы расставить приоритеты. Порядок запоминается автоматически и сохраняется между перезапусками Obsidian.
+- **Гибкая настройка** — в кодовом блоке вы сами задаёте, какой тег искать, в каких папках и нужно ли заглядывать во вложенные каталоги.
+- **Никакого лишнего шума** — плагин работает только там, где вы вставите специальный блок. Trash — значит trash.
+
+## Установка
+
+Плагин доступен в официальном каталоге Obsidian Community Plugins.
+
+1. Откройте **Настройки → Сторонние плагины (Community Plugins)**.
+2. Отключите **Безопасный режим (Restricted mode)**.
+3. Нажмите **Обзор (Browse)** и найдите **Inbox Zero**.
+4. Установите и включите.
+
+Или установите вручную:
+- Скачайте `main.js`, `manifest.json` и (опционально) `styles.css` из последнего релиза.
+- Поместите их в папку `<ваше-хранилище>/.obsidian/plugins/inbox-zero/`.
+- Перезагрузите Obsidian и включите плагин в настройках.
+
+## Использование
+
+1. Создайте заметки в папках, которые вы хотите отслеживать (например, `0. В моменте`, `1. Проекты`).
+2. Внутри этих заметок напишите нужный тег прямо в тексте: `#срочно`, `#важно`, `#баг` и т.д.
+3. В любой заметке (например, в дашборде) вставьте кодовый блок с языком `inbox-zero`:
+
+````markdown
+```inbox-zero
+tag: срочно
+folders: ["0. В моменте", "1. Проекты"]
+recursive: true
+
+
+4. Плагин заменит блок на нумерованный список с чекбоксами и ссылками на найденные файлы.
+5. **Отметьте галочку** — файл будет безвозвратно удалён. Задача выполнена, входящих меньше.
+6. **Перетащите** строку вверх или вниз — порядок запомнится для этого блока.
+
+## Настройки блока
+
+Параметры пишутся внутри фигурного блока `inbox-zero` в формате `ключ: значение`.
+
+| Параметр     | Тип               | Обязательный | По умолчанию | Описание                                                                 |
+|--------------|-------------------|:------------:|:------------:|--------------------------------------------------------------------------|
+| `tag`        | строка            | да           | —            | Тег для поиска (без `#`, например `срочно`).                             |
+| `folders`    | массив строк      | да           | —            | Список папок для сканирования.                                           |
+| `recursive`  | булево (`true` / `false`) | нет          | `true`       | Искать ли файлы во вложенных папках.                                     |
+
+### Пример блока со всеми параметрами
+
+```inbox-zero
+tag: баг
+folders: ["2. Ошибки", "1. Проекты"]
+recursive: false
+```
+
+Если папка не существует, файлы из неё просто не попадут в список — ошибки не будет.  
+Тег можно указывать в любом месте заметки обычной строкой: `Позвонить клиенту #срочно`.
+
+## Как работает удаление
+
+При установке флажка плагин вызывает `app.vault.delete(file)` — файл удаляется навсегда, минуя корзину. Будьте внимательны! Если хотите подстраховаться, сделайте резервную копию хранилища.
+
+## Сохранение порядка
+
+Плагин хранит порядок списков в собственном файле `data.json` (папка плагина). Порядок привязан к конкретному блоку (на основе пути заметки и тега). После перезагрузки Obsidian всё остаётся на своих местах. Новые файлы автоматически добавляются в конец списка.
+
+## Лицензия
+
+[MIT](LICENSE)
+
+---
+
+Сделайте Obsidian ещё более безжалостным к хаосу. Inbox Zero поможет фокусироваться только на важном.
+```
+
+Этот README.md можно сразу поместить в репозиторий, он даёт полное представление о плагине и его применении. Если нужно, добавлю русскую версию отдельным файлом или секцией.