X-Git-Url: https://git.r.bdr.sh/rbdr/oleoboard.nvim/blobdiff_plain/c0539eeac2f6245934c171abb4c1fa3051eb12cd..HEAD:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 3f7d5c1..be0b713 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # oleoboard.nvim -A tool to use [oil][oil] panes as a kanban board. +A tool to use [oil][oil] panes as a kanban-like board. + +When summoned it will load the directories in the current directory as columns. +It depends on oil so it assumes that these are editable. You can then move +files from one board to another as if you were moving tasks in a kanban board. ## Installation @@ -35,10 +39,10 @@ require('lazy').setup({ ## Default Keybinds -- `bb`, `:OleoBoardToggle`, Opens and Closes the kanban board -- `bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right -- `bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right -- `bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left -- `bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left +- `bb`, `:OleoBoardToggle`, Opens and Closes the kanban board +- `bl`, `:OleoBoardMoveEntryRight`, Moves the current entry to the right +- `bL`, `:OleoBoardMoveColumnRight`, Moves the current column to the right +- `bh`, `:OleoBoardMoveEntryLeft`, Moves the current entry to the left +- `bH`, `:OleoBoardMoveColumnLeft`, Moves the current column to the left [oil]: https://github.com/stevearc/oil.nvim