A README.md => README.md +35 -0
@@ 0,0 1,35 @@
+# remember.nvim
+
+This is a Neovim version of the Vim plugin [vim-lastplace](https://github.com/farmergreg/vim-lastplace]). It uses the same logic as vim-lastplace but also as much as possible the Neovim Lua API.
+
+When opening a file the plugin will set the cursor position to the edit position instead of top of the file. It ignores commit messages and certain buffer types.
+
+## Install
+Install using packer.nvim:
+```vim
+use 'https://git.sr.ht/~jhn/remember.nvim'
+```
+
+## Use
+To use the plugin, simply add the following to your init.vim or init.lua file:
+
+```lua
+lua <<EOF
+require "remember"
+EOF
+```
+
+## Configuration
+These are the default settings of the plugin:
+
+```lua
+lua <<EOF
+require "remember".setup {
+ ignore_filetype = { "gitcommit", "gitrebase", "svn", "hgcommit" },
+ ignore_buftype = { "quickfix", "nofile", "help" },
+ open_folds = true
+}
+EOF
+```
+
+To change them, add the Lua block above to your init.vim or init.lua file and change the values as necessary.
M lua/remember.lua => lua/remember.lua +1 -1
@@ 80,7 80,7 @@ end
api.nvim_exec([[
augroup remember_plugin
- autocmd BufWinEnter * lua set_cursor_position()
+ autocmd BufWinEnter * lua set_cursor_position()
augroup END
]], false)