docs: basic description + options

README.md

@@ -1,5 +1,32 @@
-# Neovim mokey-alert
+# mokey-alert.nvim
 
-## WIP
+[![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-blue.svg)](https://github.com/dqnid/monkey-alert.nvim/releases)
+[![License: WTFPL](https://img.shields.io/badge/License-WTFPL-yellow.svg)](https://www.wtfpl.net/about/)
 
+Git line blame by mail.
 
+## Options
+
+- `blame_text_color_hex`: hex color to use as foreground.
+- `monkey_mail_list`: list of github account emails separated by a single comma ",".
+- `blame_text`: string with the text that will appear on the blame.
+- `blame_position`: 'eol' or 'overlay' or 'right_align'.
+- `auto_attach`: whether or not create an autocmd to blame the current line automatically.
+
+## Usage
+
+### Lazyvim
+
+```lua
+{
+    dir = "dqnid/monkey-alert.nvim",
+    name = "monkey-alert",
+    opts = {
+        monkey_mail_list = "john@doe.org,another@dude.me",
+        blame_text_color_hex = "#c0ffee",
+        blame_text = "- Monkey alert 🐒",
+        blame_position = "eol",
+        auto_attach = false
+    },
+},
+```