small README cleanup
[bash-notes.git] / README.md
index b2d9f6d..032516b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ And you'll have all your settings in `~/.config/bash-notes.rc`. This file will b
 
 You can change all these settings:
 
-```Bash
+```bash
 # Binaries to use
 JQ=/usr/bin/jq
 EDITOR=/usr/bin/vim
@@ -59,6 +59,7 @@ Special attention is needed when specifying the options, in my case, using [alac
 ### Functionalities
 
 bash-notes can:
+
  * write a new note `--add "Your note title"` or in short `-a "Your note title"`
  * modify an existing note `--edit [note ID]`, short version `-e [note ID]`
  * delete a note `--delete [note ID]`, or `-d [note ID]`
@@ -69,7 +70,7 @@ The *note id* is assigned when the note is created, and that's how you refer to
 
 The `--plain` or `-p` option in short, dictates how the output from the script is formatted, here's a sample listing of all the notes:
 
-```
+```bash
 notes.sh -l
 listing all notes
 
@@ -80,7 +81,7 @@ listing all notes
 
 And here's the same listing with the plain option:
 
-```
+```bash
 notes.sh -pl
 1 - ciao nota - 25/03/2023 18:53 +0100CET
 2 - hello there - 25/03/2023 19:02 +0100CET
@@ -91,6 +92,17 @@ The plain option must precede all other options or it won't work. I'll try and f
 
 I'd love to implement some kind of searching functionality, but I'll have to look into that.
 
+### Installing
+
+Simply copy the script in your $PATH and make it executable, something like this should work:
+
+```bash
+mv notes.sh ~/bin/
+chmod 755 ~/bin/notes.sh
+```
+
+Adapt to your needs as you see fit.
+
 ### 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.
@@ -103,6 +115,7 @@ There are of course things I'd love to add, but my main goal is for it to work t
  * add a way to display a note without running vim
  * markdown?
        - maybe implement an export feature that builds the html file from the note
+ * write a bash completion script to enable autocomplete in the shell
  * other ideas may come [...]
 
 ### Contributing