diff --git a/docs/index.md b/docs/index.md index 78263128..233ff0f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,6 +30,7 @@ Follow [@taskellcli](https://twitter.com/taskellcli) on Twitter for updates - [Installation](#installation) - [Using Taskell](#using-taskell) - [Options](#options) + - [Keybinds](#Keybinds) - [Storage](#storage) - [Importing Trello Boards](#importing-trello-boards) - [Importing GitHub Projects](#importing-github-projects) @@ -87,6 +88,40 @@ If none of the above options work you can build taskell using [Stack](https://do - `-t `: import a Trello board ([see below](#importing-trello-boards)) - `-g `: import a GitHub project ([see below](#importing-github-projects)) +### Keybinds + +#### main panel + +| key | effect | +| - | - | +| `a` | add task | +| `e` | edit the task title | +| `m` | move task | +| `hjkl` | move as vim | +| `ENTER` | edit task | +| `ESC` | normal mode | +| `N` | create a new column | + +#### editing task + +| key | effect | +| - | - | +| `a` | add sub task | +| `jk` | up/down in subtask | +| `SPACE` | toggle task | +| `ENTER` | edit the description | +| `e` | edit the subtask name | +| `D` | delete a task | + +#### moving task + +| key | effect | +| - | - | +| `H` | move left | +| `J` | move down | +| `K` | move up | +| `L` | move right | + #### Tips - If you're using a simple two-column "To Do" and "Done" then use the space bar to mark an item as complete while staying in the "To Do" list. If you're using a more complicated column setup then you will want to use `H`/`L` to move tasks between columns.