Update docs

docs/configuration/advanced.md

@@ -0,0 +1,54 @@
+# Advanced configuration
+
+Other `taskwarrior-tui` configuration options are possible using the user defined attribute feature of `taskwarrior`.
+All `taskwarrior-tui` specific configuration options will begin with `uda.taskwarrior-tui.`.
+The following is a full list of all the options available and their default values implemented by `taskwarrior-tui` if not defined in your `taskrc` file.
+
+```plaintext
+uda.taskwarrior-tui.selection.indicator=•
+uda.taskwarrior-tui.selection.bold=yes
+uda.taskwarrior-tui.selection.italic=no
+uda.taskwarrior-tui.selection.dim=no
+uda.taskwarrior-tui.selection.blink=no
+uda.taskwarrior-tui.calendar.months-per-row=4
+uda.taskwarrior-tui.task-report.show-info=true
+uda.taskwarrior-tui.task-report.looping=true
+uda.taskwarrior-tui.style.context.active=black on rgb444
+uda.taskwarrior-tui.style.calendar.title=black on rgb444
+```
+
+## Configure user defined shortcuts:
+
+You can configure shortcuts to execute custom commands from your `taskwarrior`'s `taskrc` file (default: `~/.taskrc`).
+You can do this by mapping a shortcut to an executable file:
+
+```plaintext
+uda.taskwarrior-tui.shortcuts.1=~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh
+uda.taskwarrior-tui.shortcuts.2=~/.config/taskwarrior-tui/shortcut-scripts/sync.sh
+...
+```
+
+The file can have any name in any location, but must be executable.
+By default, keys `1`-`9` are available to run shortcuts.
+
+When you hit the shortcut, the script will be executed with the `selected_task_uuid` as an argument:
+
+```bash
+~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh $selected_tasks_uuid
+```
+
+For example, you can add the `personal` tag to the currently selected task with the following script in `~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh` :
+
+```plaintext
+task rc.bulk=0 rc.confirmation=off rc.dependency.confirmation=off rc.recurrence.confirmation=off "$@" modify +personal
+```
+
+By default, shortcuts are linked to the `1-9` number row keys.
+They can be customized as any other keys through `uda.taskwarrior-tui.keyconfig.shortcut1=<key>`.
+For example:
+
+```plaintext
+uda.taskwarrior-tui.keyconfig.shortcut1=n
+```
+
+You can set up shortcuts to run `task sync` or any custom bash script that you'd like.

docs/configuration/colors.md

@@ -0,0 +1,26 @@
+# Color configuration
+
+`taskwarrior-tui` reads values from your `taskwarrior`'s `taskrc` file (default: `~/.taskrc`).
+
+![](https://user-images.githubusercontent.com/1813121/96684390-bf173e80-1338-11eb-971c-ae64233d142e.png)
+
+For example, `color.active` is used to style the active task.
+If you would like to try it, open your `taskrc` file and change `color.active=white on blue`.
+
+So `color.active` will take precedence over `color.overdue`. You can see what `color.active` is by running `task show color.active` in your favorite shell prompt.
+
+The following color attributes are supported:
+
+```plaintext
+color.deleted
+color.completed
+color.active
+color.overdue
+color.scheduled
+color.due.today
+color.due
+color.blocked
+color.blocking
+color.recurring
+color.tagged
+```

docs/configuration/keys.md

@@ -0,0 +1,32 @@
+# Key configuration
+
+Configure `taskwarrior-tui` using `~/.taskrc`:
+
+`taskwarrior-tui` reads values from your `taskwarrior`'s `taskrc` file (default: `~/.taskrc`).
+
+
+```plaintext
+uda.taskwarrior-tui.keyconfig.quit=q
+uda.taskwarrior-tui.keyconfig.refresh=r
+uda.taskwarrior-tui.keyconfig.go-to-bottom=G
+uda.taskwarrior-tui.keyconfig.go-to-top=g
+uda.taskwarrior-tui.keyconfig.down=j
+uda.taskwarrior-tui.keyconfig.up=k
+uda.taskwarrior-tui.keyconfig.page-down=J
+uda.taskwarrior-tui.keyconfig.page-up=K
+uda.taskwarrior-tui.keyconfig.delete=x
+uda.taskwarrior-tui.keyconfig.done=d
+uda.taskwarrior-tui.keyconfig.start-stop=s
+uda.taskwarrior-tui.keyconfig.undo=u
+uda.taskwarrior-tui.keyconfig.edit=e
+uda.taskwarrior-tui.keyconfig.modify=m
+uda.taskwarrior-tui.keyconfig.shell=!
+uda.taskwarrior-tui.keyconfig.log=l
+uda.taskwarrior-tui.keyconfig.add=a
+uda.taskwarrior-tui.keyconfig.annotate=A
+uda.taskwarrior-tui.keyconfig.filter=/
+uda.taskwarrior-tui.keyconfig.zoom=z
+uda.taskwarrior-tui.keyconfig.context-menu=c
+uda.taskwarrior-tui.keyconfig.next-tab=]
+uda.taskwarrior-tui.keyconfig.previous-tab=[
+```