Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
damianfral committed Oct 22, 2023
1 parent 335e1c3 commit 508a676
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TIL - Today I Log

`til` is a TUI for a logbook/diary.
`til` is a TUI for a markdown logbook/diary.

## Run

Expand All @@ -21,12 +21,27 @@ Available options:
--editor STRING Editor to open markdown files (default: "vi")
```

### Keybindings

| Keybinding | Description |
| ---------- | ----------- |
| `Esc` | exit |
| `q` | exit |
| `h` | help |
| `r` | refresh current entry |
| `J` | select day before |
| `K` | select day after |
| `j` | increase scroll |
| `k` | decrease scroll |
| `e` | edit entry |

## Home Manager module

```nix
home-manager.users.my-user = {
imports = [inputs.til.homeManagerModules.default];
programs.til.enable = true;
programs.til.directory = "~/code/journal";
programs.til.editor = "nvim";
}
```

0 comments on commit 508a676

Please sign in to comment.