diff --git a/README.md b/README.md index 7b966a1..8249224 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,47 @@ -# Nix flake for a Haskell CLI application - -This flake contains a Nix package and a development shell for a sample Haskell -CLI application called `hello`. - -The Haskell package is wrapped with `generateOptparseApplicativeCompletions`, -which adds shell completion scripts. These scripts will be automatically picked -up if the resulting derivation is installed. - -The development shell provides the following tools for Haskell development: - -- [cabal-install](https://www.haskell.org/cabal/) -- [haskell-language-server](https://github.com/haskell/haskell-language-server) -- [ghcid](https://github.com/ndmitchell/ghcid) -- [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix) - - [actionlint](https://github.com/rhysd/actionlint) - - [hlint](https://github.com/ndmitchell/hlint) - - [hpack](https://github.com/sol/hpack) - - [nil](https://github.com/oxalica/nil) - - [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt) - - [ormolu](https://github.com/tweag/ormolu) - - [statix](https://github.com/nerdypeppercom/jez/statix) +# TIL - Today I Log + +`til` is a TUI for a markdown logbook/diary. + +## Run + +```shell +nix run github:damianfral/til +``` + +### Options + +```text +til v0.0.0.1 + +Usage: til [--directory STRING] [--editor STRING] + +Available options: + -h,--help Show this help text + --directory STRING Log directory (default: "./") + --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"; +} +```