summaryrefslogtreecommitdiffstats
path: root/README.md
blob: b3517dd5e66d3b28de3f154b8c9e7c9ce20e6bb7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# bash notes

### a simple note taking app written in bash

I've found myself in need of a simple way to take notes, and since the other solutions available didn't meet my needs, I've decided to write my own app.

It's a simple (enough) bash script, the only dependance (yet) is [jq](https://stedolan.github.io/jq/).

here's all the functions that I'm planning to implement:

```bash
-h | --help			: This help text
-p | --plain			: Output is in plain text (without this option the output is colored)
-l | --list			: List existing notes
-a | --add <title>		: Add new note
-m | --modify <note> 		: Modify note
-d | --date <note> 		: Modify date for note
-r | --remove <note>		: Remove note
-v | --version			: Print version
--userconf			: Export User config file
```

not all functionalities are present at the moment