Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add default setup section #95

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add default setup section #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,16 @@ Install the plugin with your preferred package manager:

## ⚙️ Configuration

For the basic setup with default configurations:

```lua
require('substitute').setup()
```

Substitute comes with the following defaults:

```lua
{
require('substitute').setup({
on_substitute = nil,
yank_substituted_text = false,
preserve_cursor_position = false,
Expand All @@ -70,7 +76,7 @@ Substitute comes with the following defaults:
use_esc_to_cancel = true,
preserve_cursor_position = false,
},
}
})
```

More details on these options is available in the sections below corresponding to the different features.
Expand Down