salvi/README.md

32 lines
723 B
Markdown

# Salvi
Salvi is a simple wiki-like note-taking web application, written in Python using
Flask framework.
**Warning**: Salvi is designed for personal, individual use. It may not be
suitable as a community or team knowledge base.
## Features
+ Write notes on the go, using Markdown syntax
+ Any note can have its own URL
+ Revision history
+ Stored in SQLite databases
+ Material Icons
+ Light/dark theme (requires JS as of now)
+ Works fine even with JavaScript disabled.
## Requirements
+ **Python** 3.6+.
+ **Flask** web framework.
+ **Peewee** ORM.
## Caveats
+ All pages created are, as of now, viewable and editable by anyone, with no
trace of users and/or passwords.
## License
[MIT License](./LICENSE).