1.0.0: added initial functionality

README.md

@@ -1,2 +1,47 @@
 # file-renamer.nvim
+
 Rename files like text inside NeoVIM.
+
+This plugin lets you edit filenames directly in a buffer and apply the changes to the file system.
+
+This plugin is inspired by and based on the functionality of
+[qpkorrs vim-renamer](https://github.com/qpkorr/vim-renamer) though it does not share any code with
+it.
+
+
+## Features
+
+- Edit filenames in a buffer
+- Navigate directories (`<CR>`)
+- Support for nested paths (`file -> dir/file`)
+- Automatically creates missing directories
+- Safe renaming (handles swaps like `a <-> b`)
+- Skips invalid or conflicting renames
+
+## Installation (lazy.nvim)
+
+```lua
+return {
+  "tiyn/file-renamer.nvim",
+}
+````
+
+## Usage
+
+First start the renaming buffer with the following command.
+
+```vim
+:Rename
+```
+
+Change the files as needed.
+Then apply the changes using the following command.
+
+```vim
+:Ren
+```
+
+## Notes
+
+* Do not change the number of lines
+* Lines starting with `#` are ignored