From e26457c13ef5206d821f81d6ed55c7203db9bc7d Mon Sep 17 00:00:00 2001
From: Micah Halter <micah@mehalter.com>
Date: Sat, 14 Jan 2023 14:24:08 -0500
Subject: [PATCH] docs: add README with basic instructions

---
 .github/README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 .github/README.md

diff --git a/.github/README.md b/.github/README.md
new file mode 100644
index 0000000..22f81d5
--- /dev/null
+++ b/.github/README.md
@@ -0,0 +1,30 @@
+# AstroNvim Structured User Example
+
+A user configuration template for [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
+```
+
+#### Clone AstroNvim
+
+```shell
+git clone https://github.com/AstroNvim/AstroNvim ~/.config/nvim
+```
+
+#### Clone the repository
+
+```shell
+git clone https://github.com/AstroNvim/split_user_example ~/.config/nvim/lua/user
+```
+
+#### Start Neovim
+
+```shell
+nvim
+```