summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnish Athalye <me@anishathalye.com>2017-03-26 11:30:36 -0400
committerAnish Athalye <me@anishathalye.com>2017-03-26 11:50:57 -0400
commitc29ba8d72224b545cbd7cf9446c3ed2ef13f8c24 (patch)
tree65b9ef0d2fa87e06d6272c0e32f4be9ef3df4849 /README.md
parentbf2a9330da8e9505aca0290488dab4121a14da4e (diff)
Add documentation on force option for clean plugin
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 468c59c..80748d8 100644
--- a/README.md
+++ b/README.md
@@ -273,16 +273,26 @@ command itself.
Clean commands specify directories that should be checked for dead symbolic
links. These dead links are removed automatically. Only dead links that point
-to the dotfiles directory are removed.
+to the dotfiles directory are removed unless the `force` option is set to
+`true`.
#### Format
Clean commands are specified as an array of directories to be cleaned.
+Clean commands support an extended configuration syntax. In this type of
+configuration, commands are specified as directory paths mapping to options. If
+the `force` option is set to `true`, dead links are removed even if they don't
+point to a file inside the dotfiles directory.
+
#### Example
```yaml
- clean: ['~']
+
+- clean:
+ ~/.config:
+ force: true
```
### Defaults