1 files changed, 14 insertions, 0 deletions
diff --git a/tools/symlinkManager/README.md b/tools/symlinkManager/README.md
new file mode 100644
index 000000000000..b0fc58c8e989
--- /dev/null
+++ b/tools/symlinkManager/README.md
@@ -0,0 +1,14 @@
+# Dotfile Symlink Manager
+
+Find and delete all symlinks to the dotfiles defined in `$BRIEFCASE`.
+
+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
+> briefcase # changes directory to $BRIEFCASE
+> make install
+```