diff --git a/README.md b/README.md index e32ea5c..b9edeb3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ 9P server for [denote](https://protesilaos.com/emacs/denote) notes. +## Dependencies + +- [plan9port](https://9fans.github.io/plan9port/) (provides `9pfuse`) + ## Installation ```sh @@ -17,6 +21,9 @@ denotesrv status denotesrv stop ``` +On startup, the server automatically mounts at `~/mnt/denote` via 9pfuse. +Use `-mount /path` to override the mount location. + ## Environment | Variable | Default | Description | @@ -28,16 +35,18 @@ denotesrv stop ``` denote/ - ctl (write) filter , cd + ctl (write) filter , cd , refresh event (read) Event stream index (read) Note metadata (respects filter) new (write) Create note: "'title' tag1,tag2" n/ / backlinks (read) Notes linking to this note + body (rw) File content ctl (write) 'd' to delete keywords (rw) Tags path (rw) Filesystem path + signature (rw) Note signature title (rw) Note title ```