From 084d0f21cd409c3a091b1e6305793e71db0b3014 Mon Sep 17 00:00:00 2001 From: Daniel Heras Quesada Date: Thu, 11 Sep 2025 16:31:10 +0200 Subject: [PATCH] docs: basic description + options --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b695da8..51d6d9b 100644 --- a/README.md +++ b/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 + }, +}, +```