diff --git a/README.md b/README.md index b6be051..6fda5f3 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,25 @@ Notabena is a free and open source note-taking app, written in pure Rust. [Join ## Features These are our current planned features. (Most features under CLI are also featured in the GUI when it's released, for the two are planned to be fully compatible) -- [x] CLI - - [x] Make notes - - [x] Edit notes - - [x] Delete notes - - [x] Delete multiple notes at once - - [x] Local SQL database +- [ ] Features + - [x] Simple note-taking - [ ] Encrypted notes - [x] Simple Markdown support - - [ ] Compatibility with the GUI + - [ ] Export & Share notes + - [ ] Add tags to notes + - [ ] Compatibility on the same device (GUI & CLI) and compatibility cross-device by account
+ _NOTE: Currently we have a simple PoC with basic prompts, but we're planning to support CLI flags like `notabena --new`/`-n` but if you run `notabena` you'll get a full-fledged TUI_ - [ ] GUI - [ ] Custom themes - [ ] Private vault: only accessible with PIN - [ ] Folders + - [ ] Multiple note types which will be shown as text in the CLI +- [ ] Protocol + - [ ] Collaboration + - [ ] E2E inspired by the Signal Protocol + - [ ] `.nb` filetype for saving notes encrypted + - [ ] Passkeys & encryption keys +nteractive TUI. ## Help us! You can help us in different ways.
@@ -28,8 +34,6 @@ You can help us in different ways.
🖥️ ・ Suggest features: File an issue (use the Suggest features issue template) and the devs will look into it.
🧹 ・ Fix issues: Are you a Rust developer and interested in the project: try to fix the issues and open a pull request! (Especially the ones tagged with `good first issue`) -**Contributing guidelines** for these three roles coming soon! - ## Installation There are a few different ways of installing Notabena: - **Recommended way:** through SourceForge: https://sourceforge.net/projects/notabena/. This requires no knowledge or programs, but if you want to run it with `notabena` you'll need to add it to `PATH` manually. Is your architecture not in there? Consider building for all the versions and [sending the binaries in our server](https://discord.gg/htNK4YcJB8).