From 159bf20447051a0e6d6f92679ef45b98ae43b082 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sof=C3=ADa=20Aritz?= Date: Mon, 27 Feb 2023 15:28:19 +0100 Subject: [PATCH] Add readme --- Cargo.toml | 2 -- README.md | 10 ++++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 86feb95..578ba68 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,8 +3,6 @@ name = "note-taking" version = "0.1.0" edition = "2021" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [dependencies] egui = "0.21" eframe = "0.21" diff --git a/README.md b/README.md new file mode 100644 index 0000000..398bffb --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Notes + +This is a simple and experimental password-based note-taking app with built-in +[password-based encryption](https://docs.rs/pwbox/0.5.0/pwbox/). + +## To-Do list +- [ ] Improve password checking +- [ ] Allow the addition of arbitrary metadata when creating a note +- [ ] Add basic markdown support (bold, italics, underline) +- [ ] Improve performance (duplicate decryption operations, tons of copying/cloning, etc) \ No newline at end of file