about summary refs log tree commit diff
path: root/users/wpcarro/tools/symlinkManager/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/wpcarro/tools/symlinkManager/README.md')
-rw-r--r--users/wpcarro/tools/symlinkManager/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/users/wpcarro/tools/symlinkManager/README.md b/users/wpcarro/tools/symlinkManager/README.md
new file mode 100644
index 000000000000..e8298ea65401
--- /dev/null
+++ b/users/wpcarro/tools/symlinkManager/README.md
@@ -0,0 +1,12 @@
+# Dotfile Symlink Manager
+
+Find and delete all symlinks to my dotfiles.
+
+Oftentimes I corrupt the state of my configuration files. The intention with
+this script is to help me clean things up when this happens. An example workflow
+might look like:
+
+```shell
+> symlink-mgr --audit
+> symlink-mgr --seriously
+```