From ec6dbf60e8bc6e1b2d4565a1c62f892697f05712 Mon Sep 17 00:00:00 2001
From: jasmine <its.jassy@pm.me>
Date: Mon, 5 Aug 2024 22:00:48 +0800
Subject: [PATCH] Update README.md

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9098a0f..399c6ad 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,38 @@
-# nvim.nix
+# NixVim Configuration for Neovim
+This repository contains my personal configuration for Neovim, managed with NixVim written in Nix.
+
+## Features
+* **Gruvbox Material**
+* **Treesitter**
+* **Telesope**
+* **AutoCompletion**
+* **Git Integration**
+* **UI Enhancement**
+
+## Installation
+**Intergration with NixOS/Home-Manager.**
+```nix
+inputs = {
+  nixvim-config.url = "git+https://git.sajenim.dev/jasmine/nvim.nix.git";
+};
+```
+
+```nix
+{ inputs, system, ... }:
+
+{
+  # NixOS
+  environment.systemPackages = [ inputs.nixvim-config.packages.${system}.default ];
+  # Home-Manager
+  home.packages = [ inputs.nixvim-config.packages.${system}.default ];
+}
+```
+
+**Build and Run**
+```sh
+nix run git+https://git.sajenim.dev/jasmine/nvim.nix.git
+```
+
+## References
+* [dc-tec/nixvim](https://github.com/dc-tec/nixvim)