Skip to content

Commit

Permalink
docs: document Precognition command
Browse files Browse the repository at this point in the history
  • Loading branch information
willothy committed Jun 3, 2024
1 parent edb7234 commit f7efdae
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,37 @@ Any hints that could appear in the same place as others should have unique prior

## ❔Usage

`precognition` can be controlled with the `Precognition` user command, as well as programmatically via the Lua API.

### Toggling

The hints can be toggled on and off with

```vim
:Precognition toggle
```
:lua require("precognition").toggle()

or

```lua
require("precognition").toggle()
```

The subcommands and functions `show` and `hide` are also available.

### Peeking

The hints can be peeked, this means that the hint will be show until the next
cursor movement.

```vim
:Precognition peek
```
:lua require("precognition").peek()

or

```lua
require("precognition").peek()
```

## 💻 Supported Versions
Expand Down

0 comments on commit f7efdae

Please sign in to comment.