commit 35e2f688f3ddb01b65205d3f1a9f66016d653169 parent 76a131e1632207a5dfbe55d41079b39a700a696d Author: mjkloeckner <martinjkloeckner@gmail.com> Date: Fri, 28 Apr 2023 23:25:12 -0300 update README.md Diffstat:
| M | README.md | | | 22 | ++++++++++++++++++---- |
1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md @@ -3,29 +3,43 @@ This is a plugin to auto save the current buffer (if modified) when the cursor is idle. + + ## Installing If you are using [vim-plug](https://github.com/junegunn/vim-plug) add this to your plugins list: ```vim - Plug 'chrisbra/Colorizer' +Plug 'mjkloeckner/autosave.vim' ``` ## Options -- Enable auto_save for only these filetypes, to see all posible filetypes - see: <https://vi.stackexchange.com/questions/5780/list-known-filetypes> +- Enable autosave for only these filetypes ```vim let g:auto_save_file_types = [ 'markdown' ] ``` -- Enable auto_save for all filetypes + To see all posible filetypes see: + <https://vi.stackexchange.com/questions/5780/list-known-filetypes> + +- Enable autosave for all filetypes ```vim let g:auto_save_all_filetypes = 0 ``` +- The event that triggers the autosave is CursorHold and CursorHoldI (see [:h + CurosrHold](https://vimdoc.sourceforge.net/htmldoc/autocmd.html#CursorHold)). + You can change the default wait time to trigger CursorHold with: + + ```vim + set updatetime = 1000 " set updatetime to 1 s (the default is 4 seconds) + ``` + + Note that a very low value may impact Vim performance. + ## License