Update Readme
This commit is contained in:
10
README.md
10
README.md
@ -13,6 +13,8 @@ A lightweight, web-based Markdown note-taking application with a Go backend and
|
||||
- 🛠️ Super Easy to build
|
||||
- 🚀 A powerful API
|
||||
|
||||

|
||||
|
||||
|
||||
## 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):
|
||||
|
||||
Reference in New Issue
Block a user