Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
backdround committed Oct 26, 2023
1 parent f8369d8 commit f064573
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
It's a Neovim plugin that improves the search experience.

It provides:

- **stable** **jump** to next / previous search pattern (regardless of the last
search direction)
- search the **word** under the **cursor** without moving (like `*` or `#`)
Expand Down Expand Up @@ -55,16 +56,17 @@ vim.keymap.set("n", "|", search.in_place)
<!-- panvimdoc-ignore-end -->

### Functions and operators
- `stable_next` / `stable_previous` - stable search motions (for "n/x/o" modes)

- `current_word{_strict}` - in-place current word search (for "n" mode)

- `in_place{_strict}` / `forward{_strict}` / `backward{_strict}` -
search operators (for "n/x/o" modes).

<br>
Functions with `_strict` postfix add word boundaries (`\<` and `\>`) for all
search patterns.
| function / operator | modes | description |
| --- | --- | --- |
| stable_next | n, x, o | Search next pattern (regardless of a previous search direction)|
| stable_previous | n, x, o | Search previous pattern (regardless of a previous search direction)|
| current_word[_strict] | n | Search current word in-place |
| in_place[_strict] | n, x, o | In-place search operator |
| forward[_strict] | n, x, o | Forward search operator |
| backward[_strict] | n, x, o | Backward search operator |

- `_strict` postfix means that a search operator / function uses a pattern with
word boundaries. In other words, the pattern is encapsulated with `\<` and `\>`.

<!-- panvimdoc-ignore-start -->

Expand Down

0 comments on commit f064573

Please sign in to comment.