Skip to content

Commit 5500eef

Browse files
Merge pull request #13 from julienvincent/readme
Readme updates
2 parents 111c8c8 + f30f606 commit 5500eef

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ The goal of `nvim-paredit` is to provide a comparable s-expression editing exper
1818
- Language extensibility
1919
- Programmable API
2020

21+
---
22+
23+
![Demo](./assets/demo.gif)
24+
2125
## Project Status
2226

2327
This is currently **beta software**. It works well in the workflows of the current maintainers but has not been thoroughly tested with many users.
@@ -156,3 +160,20 @@ paredit.api.slurp_forwards()
156160
- **`raise_form`**
157161
- **`move_to_next_element`**
158162
- **`move_to_prev_element`**
163+
164+
## Prior Art
165+
166+
### [vim-sexp](https://github.com/guns/vim-sexp)
167+
168+
Currently the de-facto s-expression editing plugin with the most extensive set of available editing operations. If you are looking for a more complete plugin with a wider range of supported languages then you might want to look into using this instead.
169+
170+
The main reasons you might want to consider `nvim-paredit` instead are:
171+
172+
+ Easier configuration and an exposed lua API
173+
+ Control over how the cursor is moved during slurp/barf. (For example if you don't want the cursor to always be moved)
174+
+ Recursive slurp/barf operations. If your cursor is in a nested form you can still slurp from the forms parent(s)
175+
+ Subjectively better out-of-the-box keybindings
176+
177+
### [vim-sexp-mappings-for-regular-people](https://github.com/tpope/vim-sexp-mappings-for-regular-people)
178+
179+
A companion to `vim-sexp` which configures `vim-sexp` with better mappings. The default mappings for `nvim-paredit` were derived from here.

assets/demo.gif

1.03 MB
Loading

0 commit comments

Comments
 (0)