Update README.md
This commit is contained in:
commit
4f4309eb71
28
README.md
Normal file
28
README.md
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user