From 4e3a3692a7276a2bde2034c30afe57b07b30e711 Mon Sep 17 00:00:00 2001
From: diogo464 <diogo464@protonmail.com>
Date: Fri, 23 Sep 2022 13:49:22 +0100
Subject: added basic readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8bd824
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# dotup
+
+CLI tool to symlink configuration files to into their correct place.
+
+Create a `dotup` file in the directory that contains all config files.
+```
+configs/
+	neovim/
+		...
+	alacritty/
+		...
+	dotup
+```
+
+Populate the config file
+```
+group desktop {
+	include group="neovim"
+	include group="alacritty"
+}
+
+group neovim {
+	link source="neovim/" target=".config/nvim"
+}
+
+group alacritty {
+	link source="alacritty/" target=".config/alacritty"
+}
+```
+
+Install the symlinks
+```bash
+dotup install desktop
+```
-- 
cgit