jab2870/knowledge-base
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Wiki Activity

Adds usage notes to readme

Browse source
This commit is contained in:
Jonathan Hodgson 2020-12-23 10:35:31 +00:00
parent d2276f323f
commit 0f2c2a56c4
1 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -23,6 +23,35 @@ kb init
This will create the necessary folders and create an sqlite database to store This will create the necessary folders and create an sqlite database to store
the index in 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 ## Goals
### Mostly Plain Text ### Mostly Plain Text