chore: added images

docs/README.md

@@ -0,0 +1,128 @@
+# Note Status for Obsidian
+
+[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aleixsoler)
+[![GitHub release](https://img.shields.io/github/v/release/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/releases)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/devonthesofa/obsidian-note-status/release.yml)](https://github.com/devonthesofa/obsidian-note-status/actions)
+[![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22note-status%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json)](https://obsidian.md/plugins?id=note-status)
+[![GitHub License](https://img.shields.io/github/license/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/blob/master/LICENSE)
+[![GitHub Stars](https://img.shields.io/github/stars/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/stargazers)
+
+Track the lifecycle of every file with statuses you control. Works on Markdown and non-Markdown, shows badges in the status bar and explorer, and adds commands, dashboards, and quick actions to keep notes moving.
+
+## Contents
+
+- [Feature Guide](docs/features.md): what the plugin can do across commands, UI surfaces, and workflows.
+- [Settings Reference](docs/settings.md): every option, grouped like the in-app settings.
+
+![[Pasted image 20251124181735.png]]
+![[Pasted image 20251124175911.png]]
+
+## Quick start
+
+1. Open Settings → Note Status.
+2. Expand **Templates & Statuses** and keep a built-in template or add your own/custom-only set.
+3. Pick where to see/change status: **Status Bar** or **Editor Toolbar**.
+4. Set a status from the badge or run `Change current note status`.
+5. Watch file explorer icons update; hover for the overview popup or click to change again.
+6. If enabled, open the **Status Dashboard** or **Grouped Status View** from the ribbon/commands.
+
+## Key features
+
+- Status picker everywhere: status bar badge, editor toolbar, explorer context menus, commands.
+- Multi-status or single-status workflows; quick-status commands for hotkeys.
+- File explorer icons with configurable placement, frames, and visual treatments (row tint, underline, dot, border).
+- Status bar badges with accent/filled/dot styles and icon/text options; template names can auto-show on conflicts.
+- Dashboards and grouped views (gated by experimental toggles and vault size limit) for vault-wide visibility and quick actions.
+- Built-in templates (Colorful, Minimal, Academic, Project) plus full custom templates and standalone custom statuses.
+- Works with YAML frontmatter and non-Markdown via a synced JSON store; frontmatter mappings let you write to multiple keys.
+
+## Data model
+
+- **Markdown**: statuses live under the tag prefix (default `obsidian-note-status`). Map templates/statuses to extra YAML keys and optionally also write to the default.
+- **Non-Markdown**: stored in `.obsidian/plugins/obsidian-note-status/non-markdown-statuses.json`, kept in sync on rename/delete.
+- **Single vs multi**: multiple statuses by default; single-status mode can store as list (`status: [draft]`) or string (`status: draft`) for compatibility.
+
+## Screenshots
+
+- Nav bar with current status
+
+    - ![[Pasted image 20251124175219.png]]
+    - ![[Pasted image 20251124175531.png]]
+
+- Status assignment:
+
+    - ![[Pasted image 20251124175250.png]]
+
+- File explorer with status icons and hover overview:
+    - ![[Pasted image 20251124175828.png]]
+- Multiple settings:
+    - ![[Pasted image 20251124181317.png]]
+- Custom templates editor:
+    - ![[Pasted image 20251124180312.png]]
+    - ![[Pasted image 20251124180453.png]]
+- Frontmatter tags mapping
+    - ![[Pasted image 20251124180719.png]]
+- Grouped status view:
+    - ![[Pasted image 20251124181043.png]]
+- Status dashboard:
+    - ![[Pasted image 20251124181152.png]]
+    - ![[Pasted image 20251124181213.png]]
+    - ![[Pasted image 20251124181233.png]]
+
+## Installation
+
+### Community Plugin Store (recommended)
+
+1. Obsidian → Settings → Community plugins.
+2. Disable Safe mode → Browse → search “Note Status”.
+3. Install and enable.
+
+### Manual
+
+1. Download the latest release from [GitHub Releases](https://github.com/devonthesofa/obsidian-note-status/releases).
+2. Extract `main.js`, `manifest.json`, and `styles.css` to `.obsidian/plugins/note-status/`.
+3. Enable in Community plugins settings.
+
+## Example workflows
+
+**Personal knowledge**
+
+```
+💡 idea → 📝 draft → ✏️ editing → ✅ completed → 📦 archived
+```
+
+**Project delivery**
+
+```
+📋 backlog → 🚦 ready → 👨‍💻 inDevelopment → 🧪 testing → 🚀 live
+```
+
+**Academic**
+
+```
+🔍 research → 📑 outline → ✏️ draft → 🔬 review → 📚 final
+```
+
+## Data format
+
+Statuses in YAML(as string or array, it depends of your settings):
+
+```yaml
+---
+obsidian-note-status:
+    - active
+    - inProgress
+---
+```
+
+Works with Dataview, Templater, QuickAdd, and search. Non-Markdown uses the JSON store noted above.
+
+## Support the project
+
+[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aleixsoler)
+
+**PayPal**: https://paypal.me/aleixsoler
+
+---
+
+**License**: MIT · **Author**: [Aleix Soler](https://aleixsoler.com)

docs/features.md

@@ -50,7 +50,11 @@
 
 ## Templates & custom statuses
 
-- Built-in templates: Colorful (idea → draft → inProgress → editing → pending → onHold → needsUpdate → completed → archived), Minimal (todo → inProgress → review → done), Academic (research → outline → draft → review → revision → final → published), Project (planning → backlog → ready → inDevelopment → testing → review → approved → live).
+- Built-in templates:
+    - Colorful (idea → draft → inProgress → editing → pending → onHold → needsUpdate → completed → archived)
+    - Minimal (todo → inProgress → review → done)
+    - Academic (research → outline → draft → review → revision → final → published)
+    - Project (planning → backlog → ready → inDevelopment → testing → review → approved → live).
 - Build your own templates (name, description, ordered statuses with emoji/Lucide + color). New templates auto-enable; you can edit/delete or reset built-ins anytime.
 - Custom statuses live outside templates; create, reorder, delete them, or run in “Custom only” mode to hide template statuses entirely.
 - Unknown status handling is configurable (icon/Lucide icon, color, and whether unknowns show in explorer/status bar).
@@ -72,10 +76,3 @@
 - Single-status mode can store the value as a list (`status: [in-progress]`) or plain string (`status: in-progress`) for compatibility with plugins that expect strings.
 - Non-Markdown files store statuses in `.obsidian/plugins/obsidian-note-status/non-markdown-statuses.json`. Rename/delete events stay in sync automatically.
 - Strict status validation removes unknown statuses when you edit a file’s statuses—use with caution if you expect ad-hoc values.
-
-## Screenshot ideas (add later)
-
-- Status picker modal with template tabs and search.
-- File explorer with icons/row coloring and the hover overview popup.
-- Status bar badge styles (accent/filled/dot) with and without template names.
-- Dashboard and Grouped Status View with filters.