README.md

   1 # bash notes
   2
   3 ### a simple note taking app written in bash
   4
   5 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.
   6
   7 It's a simple (enough) bash script, the only dependance (yet) is [jq](https://stedolan.github.io/jq/).
   8
   9 here's all the functions that I'm planning to implement:
  10
  11 ```bash
  12 -h | --help                     : This help text
  13 -p | --plain                    : Output is in plain text (without this option the output is colored)
  14 -l | --list                     : List existing notes
  15 -a | --add <title>              : Add new note
  16 -m | --modify <note>            : Modify note
  17 -d | --date <note>              : Modify date for note
  18 -r | --remove <note>            : Remove note
  19 -v | --version                  : Print version
  20 --userconf                      : Export User config file
  21 ```
  22
  23 not all functionalities are present at the moment