more documentation

This commit is contained in:
Gamosoft 2025-11-05 17:57:13 +01:00
parent 0afa382df9
commit db5264eccb
2 changed files with 16 additions and 0 deletions

View File

@ -6,6 +6,8 @@
NoteDiscovery is a **lightweight, self-hosted note-taking application** that puts you in complete control of your knowledge base. Write, organize, and discover your notes with a beautiful, modern interface—all running on your own server.
![Note Discovery](screenshot.jpg)
## 🎯 Who is it for?
- **Privacy-conscious users** who want complete control over their data
@ -92,6 +94,20 @@ python run.py
- PyYAML - Configuration handling
- aiofiles - Async file operations
## 📚 Documentation
Want to learn more? **The full documentation lives inside the app as interactive notes!**
Once you've started NoteDiscovery, you'll find comprehensive guides on:
- 🎨 **THEMES.md** - Theme customization and creating custom themes
- ✨ **FEATURES.md** - Complete feature list and keyboard shortcuts
- 🔌 **PLUGINS.md** - Plugin system and available plugins
- 🌐 **API.md** - REST API documentation and examples
**Can't wait to start the app?** Browse the documentation notes directly on GitHub in the [`data/notes/`](data/notes/) folder!
💡 **Tip:** These documentation files are regular markdown notes—edit them, add your own notes, or use them as templates. It's your knowledge base!
## 🔒 Security Considerations
NoteDiscovery is designed for **self-hosted, private use**. Please keep these security considerations in mind:

BIN
screenshot.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 363 KiB