knazarov/notes.sh
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Konstantin Nazarov 2021-05-16 20:26:08 +00:00
parent 9032586abf
commit 774ab9d17e
Signed by: knazarov
GPG key ID: 4CFE0A42FA409C22
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -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. 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. 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
```