Skip to content

Commit d460067

Browse files
committed
docs: update readme
1 parent 976a443 commit d460067

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ Text editing in Neovim with immediate visual feedback: view the effects of any c
77
<p><sub>Theme: <a href="https://github.com/folke/tokyonight.nvim">tokyonight.nvim</a></sub></p>
88

99
## :sparkles: Motivation and Features
10-
In version 0.8, Neovim has introduced the `command-preview` feature.
11-
Contrary to what "command preview" suggests, previewing any given
12-
command does not work out of the box: you need to manually update the buffer text and set
13-
highlights *for every command*.
14-
15-
This plugin tries to change that: it provides a **simple API for creating previewable commands**
16-
in Neovim. Just specify the command you want to run and live-command will do all the
17-
work for you. This includes viewing **individual insertions, changes and deletions** as you
18-
type.
10+
In Neovim version 0.8, the `command-preview` feature has been introduced.
11+
Despite its name, it does not enable automatic previewing of any command.
12+
Instead, users must manually update the buffer text and set highlights *for each command*.
13+
14+
This plugin aims to address this issue by offering a **simple API for creating previewable commands**
15+
in Neovim. Simply provide the command you want to preview and live-command will do all the
16+
work for you. This includes viewing **individual insertions, changes and deletions** as you type.
1917

2018
## Requirements
2119
Neovim 0.8+

0 commit comments

Comments
 (0)