diff --git a/README.md b/README.md index 752ed94..877c544 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Easy encryption with gpg for files +> "Easy file encryption in Neovim using GPG. Quickly encrypt files with a single keybind, manage default recipients, and optionally delete originals after encryption. Lightweight, Lua-configurable, and perfect for secure workflows." - GPT + ## Usage Install with `ya pkg add Ascyii/gpg`. @@ -13,4 +15,13 @@ require("gpg"):setup { } ``` +Then add a keybind to the `keymap.toml` + +```toml +[mgr] +prepend_keymap = [ + {on = [ "g", "E" ], run = "plugin gpg", desc = "Gpg encrypt the hovered file"} +] +``` + Code was taken from `yazi-rs` and `Rolv-Apneseth`.