From 4f4309eb71c4d1e953c748195c669d22cf42e710 Mon Sep 17 00:00:00 2001
From: Volodymyr Patuta <90917-fiplox@users.noreply.framagit.org>
Date: Tue, 24 Nov 2020 19:13:52 +0100
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e61ebb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# rnote
+[![license](https://img.shields.io/badge/licence-GPLv3-blue)](https://framagit.org/fiplox/rpass/-/blob/main/LICENSE)
+
+A minimal note taking cli tool. 
+
+## Description
+
+**rnote** creates files in a date-named directories with a name of a header of the note. 
+
+Example :
+
+```
+.rnote/
+├── 2020-03-20
+│   └── Lockdown
+└── 2020-10-20
+    └── New Lockdown
+```
+
+## TODO
+
+- [ ] Create a note
+- [ ] Delete a note
+- [ ] Show all notes
+- [ ] Show all notes from `DATE`
+- [ ] Search a note by header
+- [ ] Search a note by word
+- [ ] Export a note to `.md` format