Adds usage notes to readme
This commit is contained in:
parent
d2276f323f
commit
0f2c2a56c4
1 changed files with 29 additions and 0 deletions
29
README.md
29
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`
|
||||
|
||||

|
||||
|
||||
View a file with `kb view`. You can use the filename, the title or the id to
|
||||
specify the file.
|
||||
|
||||

|
||||
|
||||
Create a new file with `kb new`.
|
||||
|
||||
This will open your default editor.
|
||||
|
||||

|
||||
|
||||
Delete a file with `kb delete`.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
|
||||
## Goals
|
||||
|
||||
### Mostly Plain Text
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue