-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
+-e | --edit <note> : Modify note
-d | --delete [<note> | all] : Delete note
-v | --version : Print version
--userconf : Export User config file
# see example in the addnote function
TERM_OPTS="--class notes --title notes -e "
+# set this to true to have output in plain text
+# or use the -p option on the command line before every other option
+PLAIN=false
# base directory for program files
BASEDIR=~/.local/share/bash-notes
# notes database in json format
Adapt to your needs as you see fit.
+### Debugging
+
+If the script doesn't work for you for some reasons, you can turn on debugging by running the script like this:
+
+```bash
+DEBUG=true notes.sh [options]
+```
+
+And then you'll be able to check all that happened in the log file at `/tmp/debug_bash-notes.log`
+
### Vision
Ok, maybe vision is a bit of a stretch, but I've written this script to use it in my daily workflow with [rofi](https://github.com/davatorium/rofi) and [i3wm](https://github.com/i3/i3). I'll adapt the way it works to better suit this need of mine.
It'd mean so much to receive some feedback, patches if you feel like contributing, I'm not expecting much as this is a personal project, but feel free to interact as much as you want.
+### ChangeLog
+
+ * v0.2 - debugging implemented
+ - you can now generate a debug log in case something doesn't work
+ * v0.1 - first public upload
+ - all major functionalities are present and working
+
### Mantainer
* [danix](https://danix.xyz) - it's just me, really...
