docs

sigmonsays · Dec 3, 2022 · 21d9673 · 21d9673
1 parent 556b5e3
commit 21d9673
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -58,8 +58,14 @@ files can be specified by passing -c with a file multiple times.
 If no configuration file is provided, dotbot.yaml is assumed if it exists in the
 current directory.
 
+the clean block indicates directories to clean up broken symlinks (aka, dangling symlinks)
+the tilde (`~`) is automatically expanded to the uses home directory. The path is evaluated
+as a glob so wildcards may be used.
+
 Sample configuration
 
+     clean:
+       - '~'
      mkdirs:
        - ~/asdf
      symlinks: