feat: revamp core configuration for improved customizability

README.md

@@ -1,31 +1,34 @@
-# Neovim Config
+# AstroNvim Template
 
-## Installation
+**NOTE:** This is for AstroNvim v5+
 
-```sh
-git clone https://github.com/prnk28/nvim ~/.config/nvim
-rm -rf ~/.config/nvim/.git
-nvim
+A template for getting started with [AstroNvim](https://github.com/AstroNvim/AstroNvim)
+
+## 🛠️ Installation
+
+#### Make a backup of your current nvim and shared folder
+
+```shell
+mv ~/.config/nvim ~/.config/nvim.bak
+mv ~/.local/share/nvim ~/.local/share/nvim.bak
+mv ~/.local/state/nvim ~/.local/state/nvim.bak
+mv ~/.cache/nvim ~/.cache/nvim.bak
 ```
 
-## Features
+#### Create a new user repository from this template
 
-- 🔥 Neovim 0.8.0
-- 🔥 Treesitter
-- 🔥 LSP
-- 🔥 LSP Diagnostics
-- 🔥 LSP Snippets
-- 🔥 LSP Formatting
-- 🔥 LSP Code Actions
-- 🔥 LSP Hover
-- 🔥 LSP Signature Help
-- 🔥 LSP Diagnostics UI
-- 🔥 LSP Rename UI
-- 🔥 LSP References UI
-- 🔥 LSP Document Symbols UI
-- 🔥 LSP Workspace Symbols UI
-- 🔥 LSP Code Lens
-- 🔥 LSP Document Highlight
-- 🔥 LSP Document Diagnostics
-- 🔥 LSP Document Formatting
-- 🔥 LSP Document Code
+Press the "Use this template" button above to create a new repository to store your user configuration.
+
+You can also just clone this repository directly if you do not want to track your user configuration in GitHub.
+
+#### Clone the repository
+
+```shell
+git clone https://github.com/<your_user>/<your_repository> ~/.config/nvim
+```
+
+#### Start Neovim
+
+```shell
+nvim
+```