@@ 0,0 1,17 @@
+# srht-patches.nvim
+
+srht-patches.nvim is a plugin for neovim that helps to set the status of patchsets.
+It currently supports "applied" (`PatchApplied`), "rejected" (`PatchRejected`) and "needs revision" (`PatchNeedsRevision`).
+You can either bind these commands to bindings or use the `setup` function to configure this plugin to ask for the status on save (`auto_check`).
+This can be further fine-tuned by setting a list of regexes (`address_list`) against which the To-header will be compared.
+
+## Configuration
+
+Use the setup function to configure this plugin.
+
+```lua
+require("srht-patches").setup({
+ auto_check = true,
+ address_list = { "~xenrox/.*@lists.xenrox.net" },
+})
+```