From 774ab9d17ea76bf7712888b2123d238852938b81 Mon Sep 17 00:00:00 2001 From: Konstantin Nazarov Date: Sun, 16 May 2021 20:26:08 +0000 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 69b0e11..0b5a323 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,25 @@ This project allows you to keep plaintext notes, and attach files to them (like What makes it special is that it uses a Maildir format to store notes. This allows you to easily sync your notes with any mail server, and have your notes accessible on the go through your email client. NB: This is alpha software, use with caution. + +## Usage + +By default, `notes.sh` will create new entries in `~/Maildir/personal/Notes`, which you can override by setting `$NOTES_SH_BASEDIR`. + +To create a new note (will open a new editor window): + +```sh +./note.sh -n +``` + +To list all existing notes with their titles: + +```sh +./note.sh -l +``` + +To select a note with fuzzy search and edit it: + +```sh +./notes.sh -l | fzf | xargs -o ./notes.sh -e +```