bryan
/
persisted.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update README.md

main
olimorris 2024-03-12 21:46:21 +00:00
parent a192a0a11a
commit c76c789d90
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -325,7 +325,7 @@ In this setup, `~/.config` and `~/.local/nvim` are still going to behave in thei
### Ignored branches
You may specify a table of patterns that match against braches for which the plugin will **never** autosave and autoload from. For example:
You may specify a table of patterns that match against branches for which the plugin will **never** autosave and autoload from:
```lua
require("persisted").setup({

21
doc/persisted.nvim.txt
View File

@ -160,8 +160,14 @@ The plugin comes with the following defaults:
follow_cwd = true, -- change session file name to match current working directory if it changes
allowed_dirs = nil, -- table of dirs that the plugin will auto-save and auto-load from
ignored_dirs = nil, -- table of dirs that are ignored when auto-saving and auto-loading
ignored_branches = nil, -- table of branch patterns that are ignored for auto-saving and auto-loading
telescope = {
reset_prompt = true, -- Reset the Telescope prompt after an action?
mappings = { -- table of mappings for the Telescope extension
change_branch = "<c-b>",
copy_session = "<c-c>",
delete_session = "<c-d>",
},
},
})
<
@ -352,6 +358,21 @@ their default setting (ignoring all listed directory and its children), however
`/` and `/tmp` will only ignore those directories exactly.
IGNORED BRANCHES ~
You may specify a table of patterns that match against branches for which the
plugin will **never** autosave and autoload from:
>lua
require("persisted").setup({
ignored_branches = {
"^master",
"feature/%u"
},
})
<
EVENTS / CALLBACKS ~
The plugin fires events at various points during its lifecycle: