diff --git a/README.md b/README.md index 118fb5d..dff970c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ -# colourfulDiff.nvim -Still under developing +
-## Feature -Add Colourful background to diff patch + + +**ColorfulDiff.nvim** is a extremely light plugin that renders highlights for git diff. + +![image](https://github.com/user-attachments/assets/ba072e82-2adb-4c42-ab57-718ce745f58f) + +## 🚀 Getting Started + +### Installation +If you are using Lazy.nvim: +```lua +require("lazy").setup({ + ..., + {"Chen-Yulin/ColorfulDiff.nvim"}, +}) +``` + +### Configuration +TODO...