From 0ade724f20b8cfa423dfa26168f8d72a96554a46 Mon Sep 17 00:00:00 2001 From: danix Date: Fri, 24 Mar 2023 17:51:15 +0100 Subject: adding readme to project --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3517dd --- /dev/null +++ b/README.md @@ -0,0 +1,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 : 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 \ No newline at end of file -- cgit v1.2.3