Skip to content

Commit

Permalink
docs: describe some of the features in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tmillr committed May 17, 2024
1 parent 15869dd commit 3dfc66d
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ This plugin is an autosaver for Neovim that automatically saves all of your chan
- to offer at least some customization via options, as well as the ability to easily enable/disable
- to be better or more correct than `CursorHold` autosavers and not depend on `CursorHold` if feasible

### Additional Features

- has its own independent timer, distinct from `'updatetime'`, which may be set to any value in ms
- the timer is only reset/started on buffer changes, not cursor movements or other uninteresting events
- keeps buffers in sync with the filesystem by frequently running `:checktime` in the background for you (e.g. on ctrl-z or suspend, resume, command, etc.)
- intelligently ignores `'readonly'` and other such un-writeable buffers/files (i.e. the writing of files with insufficient permissions must be attempted manually with `:w`)

For any questions, help with setup, or general help, you can try [discussions][q&a]. For issues, bugs, apparent bugs, or feature requests, feel free to [open an issue][issues] or [create a pull request][prs].

## Installation
Expand Down

0 comments on commit 3dfc66d

Please sign in to comment.