diff --git a/README.md b/README.md index 9098a0f..6029cc8 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 by NixVim with 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)