Skip to content

Commit

Permalink
docs: mentions the docs folder in README
Browse files Browse the repository at this point in the history
We might add more stuff in there later.
  • Loading branch information
ju1ius committed Nov 24, 2023
1 parent e7c157a commit 2cfd777
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@ clisnips key-bindings bash
clisnips key-bindings zsh
```

Open a *new* shell and type the `Alt+s` keyboard shortcut to open the snippets library.
Then:
* Either open a *new* shell or source your shell rc file,
* and type the `Alt+s` keyboard shortcut to open the snippets library.

## Usage

Clisnips stores snippets in a local SQLite database,
using an FTS5 table to enable full-text search.
The search input accepts the whole [FTS5 full-text query syntax][fts5-ref].

Please have a look at the docs for getting started on
Please have a look at [the docs][docs-folder] for getting started on
[writing your own snippets][creating-snippets].

You may also read the [quick-tour][],
Expand All @@ -51,5 +53,6 @@ to help you manage your snippets. Please run `clisnips --help` to read the CLI d


[quick-tour]: https://github.com/ju1ius/clisnips/blob/master/snippets/quick-tour.toml
[docs-folder]: https://github.com/ju1ius/clisnips/blob/master/docs/
[creating-snippets]: https://github.com/ju1ius/clisnips/blob/master/docs/creating-snippets.md
[fts5-ref]: https://www.sqlite.org/fts5.html#full_text_query_syntax

0 comments on commit 2cfd777

Please sign in to comment.