more documentation
This commit is contained in:
parent
0afa382df9
commit
db5264eccb
16
README.md
16
README.md
|
|
@ -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.
|
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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## 🎯 Who is it for?
|
## 🎯 Who is it for?
|
||||||
|
|
||||||
- **Privacy-conscious users** who want complete control over their data
|
- **Privacy-conscious users** who want complete control over their data
|
||||||
|
|
@ -92,6 +94,20 @@ python run.py
|
||||||
- PyYAML - Configuration handling
|
- PyYAML - Configuration handling
|
||||||
- aiofiles - Async file operations
|
- 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
|
## 🔒 Security Considerations
|
||||||
|
|
||||||
NoteDiscovery is designed for **self-hosted, private use**. Please keep these security considerations in mind:
|
NoteDiscovery is designed for **self-hosted, private use**. Please keep these security considerations in mind:
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 363 KiB |
Loading…
Reference in New Issue