Skip to content

Commit 7666740

Browse files
committed
docs: refresh README (template-aligned)
1 parent a0a2618 commit 7666740

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
1-
# Mini-Notes
1+
# notes-frontend
22

3-
<!-- Badges: update workflow filename/branch if needed -->
43
<p align="left">
5-
<!-- Native GitHub badge: zeigt den letzten Run auf main -->
6-
<a href="https://github.com/rluetken-dev/notes-frontend/actions/workflows/ci.yml">
7-
<img alt="CI" src="https://github.com/rluetken-dev/notes-frontend/actions/workflows/ci.yml/badge.svg?branch=main">
8-
</a>
9-
<!-- Node version -->
4+
<a href="https://github.com/rluetken-dev/notes-frontend/actions/workflows/ci.yml">
5+
<img alt="CI" src="https://github.com/rluetken-dev/notes-frontend/actions/workflows/ci.yml/badge.svg?branch=main">
6+
</a>
107
<img alt="Node" src="https://img.shields.io/badge/node-%E2%89%A518-339933?logo=node.js&logoColor=white">
11-
<!-- License -->
128
<img alt="License" src="https://img.shields.io/badge/license-MIT-blue.svg">
13-
<!-- ESLint -->
149
<img alt="ESLint" src="https://img.shields.io/badge/lint-ESLint-4B32C3?logo=eslint&logoColor=white">
15-
<!-- Prettier -->
1610
<img alt="Prettier" src="https://img.shields.io/badge/format-Prettier-F7B93E?logo=prettier&logoColor=black">
1711
</p>
1812

19-
A tiny, fast notes app as a pure frontend demo. No backend, no build chain required — just open it via a local web server.
13+
A tiny, fast notes app as a **pure frontend** demo. No backend or bundler required — just open it via a local web server.
14+
15+
Pairs with **[notes-backend](https://github.com/rluetken-dev/notes-backend)**. This frontend is fully standalone (localStorage), the backend is optional.
2016

2117
> **Tech stack:** Vanilla JS (ES Modules), HTML5, CSS (Design Tokens, Light/Dark Mode), localStorage, ESLint (Flat Config), Prettier
2218
@@ -34,11 +30,13 @@ A tiny, fast notes app as a pure frontend demo. No backend, no build chain requi
3430
- [Backup (Export/Import)](#backup-exportimport)
3531
- [Keyboard Shortcuts](#keyboard-shortcuts)
3632
- [Linting & Formatting](#linting--formatting)
33+
- [Scripts](#scripts)
3734
- [Data & Privacy](#data--privacy)
3835
- [Roadmap](#roadmap)
3936
- [Deployment](#deployment)
4037
- [Troubleshooting](#troubleshooting)
4138
- [License](#license)
39+
- [Related](#related)
4240

4341
---
4442

@@ -47,7 +45,7 @@ A tiny, fast notes app as a pure frontend demo. No backend, no build chain requi
4745
- ✍️ **Create / edit / delete notes**
4846
- 📌 **Pin** important notes to keep them on top
4947
- 🔎 **Live search** (title & content)
50-
- #️⃣ **#tags in search** (AND filter; tags are extracted on-the-fly from title/content)
48+
- #️⃣ **#tags in search** (AND filter; tags are extracted onthefly from title/content)
5149
-**Search highlighting** (`<mark>` for text; highlighted tag chips)
5250
- ⬇️⬆️ **Export / Import** (JSON; merge or replace existing notes)
5351
- 🌓 **Dark Mode** with **system detection** & **toggle** (persisted in `localStorage`)
@@ -67,14 +65,14 @@ A tiny, fast notes app as a pure frontend demo. No backend, no build chain requi
6765
<!-- Shown when GitHub is in light mode -->
6866
<source media="(prefers-color-scheme: light)" srcset="assets/screenshot-light.png?v=2">
6967
<!-- Fallback for older clients -->
70-
<img src="assets/screenshot-light.png?v=2" alt="Mini-Notes — screenshot" width="900">
68+
<img src="assets/screenshot-light.png?v=2" alt="notes-frontend — screenshot" width="900">
7169
</picture>
7270
</p>
7371

7472
<details>
7573
<summary>Show dark theme explicitly</summary>
7674
<p align="center">
77-
<img src="assets/screenshot-dark.png?v=2" alt="Mini-Notes — dark theme" width="900">
75+
<img src="assets/screenshot-dark.png?v=2" alt="notes-frontend — dark theme" width="900">
7876
</p>
7977
</details>
8078

@@ -83,7 +81,7 @@ A tiny, fast notes app as a pure frontend demo. No backend, no build chain requi
8381
## Requirements
8482

8583
- **Browser:** recent versions of Chrome/Edge, Firefox, or Safari.
86-
- **Node.js (optional dev tools only):** Node **18+** (recommended **20+**) and npm. Not needed to _use_ the app, but helpful for `npm run lint`/`format` and CI.
84+
- **Node.js (optional dev tools only):** Node **18+** (recommended **20+**) and npm. Not needed to _use_ the app, but helpful for `npm run lint`/`format` and CI.
8785
- **Local web server:** required because of ES Modules (see Quick Start for options).
8886

8987
---
@@ -94,7 +92,7 @@ A tiny, fast notes app as a pure frontend demo. No backend, no build chain requi
9492
9593
```bash
9694
# 1) Clone the repo
97-
# git clone <your-repo-url>
95+
git clone https://github.com/rluetken-dev/notes-frontend.git
9896
cd notes-frontend
9997

10098
# 2) (optional) Install dev dependencies for lint/format
@@ -215,6 +213,14 @@ npm run format
215213

216214
---
217215

216+
## Scripts
217+
218+
- `npm run format` – format code with Prettier
219+
- `npm run format:check` – verify formatting
220+
- `npm run lint` – ESLint (Flat Config)
221+
222+
---
223+
218224
## Data & Privacy
219225

220226
- All data is stored **locally in the browser** via `localStorage`.
@@ -225,7 +231,7 @@ npm run format
225231

226232
---
227233

228-
## Roadmap (ideas)
234+
## Roadmap
229235

230236
- Tag management (rename/delete, suggestions while typing)
231237
- Result snippets (show a short context around search hits)
@@ -287,14 +293,11 @@ npm run format
287293

288294
## License
289295

290-
MIT (feel free to use, learn, and extend)
296+
MIT feel free to use, learn, and extend.
291297

292-
Related:
293-
294-
- Backend: https://github.com/rluetken-dev/notes-backend
295-
- Frontend: https://github.com/rluetken-dev/notes-frontend
298+
---
296299

297-
Related:
300+
## Related
298301

299302
- Backend: https://github.com/rluetken-dev/notes-backend
300303
- Frontend: https://github.com/rluetken-dev/notes-frontend

0 commit comments

Comments
 (0)