Skip to content

Commit 07af2af

Browse files
committed
docs: integrate commits.md (badge + section) and refresh README
1 parent 7666740 commit 07af2af

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<img alt="License" src="https://img.shields.io/badge/license-MIT-blue.svg">
99
<img alt="ESLint" src="https://img.shields.io/badge/lint-ESLint-4B32C3?logo=eslint&logoColor=white">
1010
<img alt="Prettier" src="https://img.shields.io/badge/format-Prettier-F7B93E?logo=prettier&logoColor=black">
11+
<img alt="Conventional Commits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg">
1112
</p>
1213

1314
A tiny, fast notes app as a **pure frontend** demo. No backend or bundler required — just open it via a local web server.
@@ -31,6 +32,7 @@ Pairs with **[notes-backend](https://github.com/rluetken-dev/notes-backend)**. T
3132
- [Keyboard Shortcuts](#keyboard-shortcuts)
3233
- [Linting & Formatting](#linting--formatting)
3334
- [Scripts](#scripts)
35+
- [Commits & Changelog](#commits--changelog)
3436
- [Data & Privacy](#data--privacy)
3537
- [Roadmap](#roadmap)
3638
- [Deployment](#deployment)
@@ -45,7 +47,7 @@ Pairs with **[notes-backend](https://github.com/rluetken-dev/notes-backend)**. T
4547
- ✍️ **Create / edit / delete notes**
4648
- 📌 **Pin** important notes to keep them on top
4749
- 🔎 **Live search** (title & content)
48-
- #️⃣ **#tags in search** (AND filter; tags are extracted onthefly from title/content)
50+
- #️⃣ **#tags in search** (AND filter; tags are extracted on-the-fly from title/content)
4951
-**Search highlighting** (`<mark>` for text; highlighted tag chips)
5052
- ⬇️⬆️ **Export / Import** (JSON; merge or replace existing notes)
5153
- 🌓 **Dark Mode** with **system detection** & **toggle** (persisted in `localStorage`)
@@ -152,8 +154,8 @@ notes-frontend/
152154

153155
- `#work` → notes tagged `#work`
154156
- `#work #inbox` → notes that have **both** tags
155-
- `meeting` → fulltext search
156-
- `meeting #work` → fulltext **and** tag filter
157+
- `meeting` → full-text search
158+
- `meeting #work` → full-text **and** tag filter
157159

158160
---
159161

@@ -192,7 +194,7 @@ notes-frontend/
192194

193195
- **Save new note:** `Ctrl/Cmd + Enter`
194196
- **Theme toggle:** click `🌓`
195-
- Rightclick on `🌓` → reset to **System**
197+
- Right-click on `🌓` → reset to **System**
196198

197199
---
198200

@@ -221,6 +223,25 @@ npm run format
221223

222224
---
223225

226+
## Commits & Changelog
227+
228+
This repo follows **Conventional Commits** to keep history and changelogs clean.
229+
See **[commits.md](./commits.md)** for the rules, allowed types, scopes, and examples.
230+
231+
**Examples**
232+
233+
- `feat(ui): add search highlight for tags`
234+
- `fix(storage): handle empty import file gracefully`
235+
- `docs: update README with screenshots`
236+
- `chore(prettier): format markdown`
237+
238+
**Releases**
239+
240+
- Tag releases as `vX.Y.Z` (SemVer).
241+
- Keep release notes concise and link the compare view.
242+
243+
---
244+
224245
## Data & Privacy
225246

226247
- All data is stored **locally in the browser** via `localStorage`.
@@ -236,7 +257,7 @@ npm run format
236257
- Tag management (rename/delete, suggestions while typing)
237258
- Result snippets (show a short context around search hits)
238259
- Sorting options (e.g., by `updatedAt`, `title`)
239-
- Markdown preview (readonly render)
260+
- Markdown preview (read-only render)
240261
- PWA (offline, installable)
241262
- IndexedDB storage (scales better than localStorage)
242263
- Tests: unit (Vitest) & end-to-end (Playwright)

0 commit comments

Comments
 (0)