diff --git a/README.md b/README.md index b5dfbb4..84c25a1 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,35 @@ kb init This will create the necessary folders and create an sqlite database to store the index in +## Usage + +List tracked files with `kb list` + +![Listing Files](./assets/list.rec) + +View a file with `kb view`. You can use the filename, the title or the id to +specify the file. + +![View a file](./assets/view.rec.gif) + +Create a new file with `kb new`. + +This will open your default editor. + +![New file](./assets/new.rec.gif) + +Delete a file with `kb delete`. + +![Delete a file](./assets/del.rec.gif) + +Fuzzy search for files using `kb fuzzy` (or just `kb` without augments). + +From the fuzzy search, you can use `ctrl-v` to view, `ctrl-e` to edit, `ctrl-d` +to delete or `ctrl-n` to create a new file with the current query as the name. + +![Fuzzy search](./assets/fuzzy.rec.gif) + + ## Goals ### Mostly Plain Text