added basic readme

1 files changed, 34 insertions, 0 deletions

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
+```