Update Readme

This commit is contained in:
2025-11-11 17:22:39 +01:00
parent 5a4ef1431f
commit 5e30a5cf5d
4 changed files with 20 additions and 8 deletions

View File

@ -13,6 +13,8 @@ A lightweight, web-based Markdown note-taking application with a Go backend and
- 🛠️ Super Easy to build
- 🚀 A powerful API
![alt text](image.png)
## Features
@ -37,6 +39,12 @@ A lightweight, web-based Markdown note-taking application with a Go backend and
* **Lightweight Frontend:** Built with htmx for dynamic interactions, minimizing JavaScript complexity.
* **Go Backend:** Fast and efficient Go server handles file operations, indexing, and serving the frontend.
## Road Map
- Share notes in markdown / pdf
- Publics notes.
- Secure by user/password (You can use Authelia/Authentik for now)
## Getting Started
@ -70,7 +78,7 @@ The frontend uses [Vite](https://vitejs.dev/) to bundle CodeMirror 6 and other J
```bash
npm run build
```
This compiles `frontend/src/` files into `static/dist/` (served by Go).
3. **Development mode** (auto-rebuild on changes):