Skip to content

Commit

Permalink
Revert "docs: update readme"
Browse files Browse the repository at this point in the history
This reverts commit 23b2ef4.
  • Loading branch information
smjonas committed Sep 9, 2024
1 parent 23b2ef4 commit 79f89a2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 67 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ Text editing in Neovim with immediate visual feedback: view the effects of any c
<p><sub>Theme: <a href="https://github.com/folke/tokyonight.nvim">tokyonight.nvim</a></sub></p>

## :sparkles: Motivation and Features
In Neovim version 0.8, the `command-preview` feature has been introduced.
Despite its name, it does not enable automatic previewing of any command.
Instead, users must manually update the buffer text and set highlights *for each command*.

This plugin aims to address this issue by offering a **simple API for creating previewable commands**
in Neovim. Simply provide the command you want to preview and live-command will do all the
work for you. This includes viewing **individual insertions, changes and deletions** as you type.
In version 0.8, Neovim has introduced the `command-preview` feature.
Contrary to what "command preview" suggests, previewing any given
command does not work out of the box: you need to manually update the buffer text and set
highlights *for every command*.

This plugin tries to change that: it provides a **simple API for creating previewable commands**
in Neovim. Just specify the command you want to run and live-command will do all the
work for you. This includes viewing **individual insertions, changes and deletions** as you
type.

## Requirements
Neovim 0.8+
Expand Down
60 changes: 0 additions & 60 deletions migrate_to_v2.md

This file was deleted.

0 comments on commit 79f89a2

Please sign in to comment.