diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7202d1 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# jj-mini.diff + +A Neovim plugin to provide `mini.diff`-like functionality for Jujutsu (`jj`) repositories, with a focus on displaying Git signs for changes. + +## Features + +* **Jujutsu Git Signs:** Visually indicate added, modified, and deleted lines directly in your Neovim buffer, reflecting changes in your `jj` working copy. +* **Seamless Integration:** Designed to integrate smoothly with Neovim's existing `diff` capabilities and user interface. + +## Installation + +(TODO: Provide installation instructions using popular Neovim plugin managers like `packer.nvim`, `lazy.nvim`, or `vim-plug`.) + +## Usage + +(TODO: Explain how to activate and use the plugin, including any commands or keybindings.) + +## Configuration + +(TODO: Document available configuration options for customizing signs, colors, and behavior.)