summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic Guegan <loic.guegan@mailbox.org>2024-04-19 14:26:58 +0200
committerLoic Guegan <loic.guegan@mailbox.org>2024-04-19 14:26:58 +0200
commitfd45b611986fdd36243099e6801b429eef75c2ca (patch)
tree9d0158292536a86ea87f637576fc7c4dce23f714 /README.md
parentab5c2a08c793decc450d2c2803008f0f3c43791b (diff)
Improve pnote API
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index a8bed45..41007ed 100644
--- a/README.md
+++ b/README.md
@@ -13,36 +13,37 @@ Installation:
Create a new project:
```
-> pnote ~/mynotes
+> pnote -d ~/mynotes
> # See configuration in ~/mynotes/config.json
+> # If -d not specified, ${HOME}/.pnote will be used
```
Open and edit today's note file:
```
-> pnote ~/mynotes -t
+> pnote -d ~/mynotes -t
```
## Features
Search for files:
```
-> pnote ~/mynotes search -h
+> pnote -d ~/mynotes search -h
```
Tag files:
```
-> pnote ~/mynotes tag -h
+> pnote -d ~/mynotes tag -h
```
Manage your project:
```
-> pnote ~/mynotes admin -h
+> pnote -d ~/mynotes admin -h
```
Export your notes:
```
-> pnote ~/mynotes search --subpath | pnote ~/mynotes export --json
-> pnote ~/mynotes search --subpath | pnote ~/mynotes export --template template.txt
+> pnote -d ~/mynotes search --subpath | pnote -d ~/mynotes export --json
+> pnote -d ~/mynotes search --subpath | pnote -d ~/mynotes export --template template.txt
```
For more information on *pnote*: