summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnish Athalye <me@anishathalye.com>2014-06-08 11:30:10 -0700
committerAnish Athalye <me@anishathalye.com>2014-06-08 11:32:45 -0700
commitabb825048b348e3892902fa92df1edacd3dd248f (patch)
tree204149781376e1bea4a0e776b410e5ae94dc9343 /README.md
parent24f49603c8aeb7161ad83ff792dfa63baadb7362 (diff)
Add Cleaner executor
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index eb09942..a5c6457 100644
--- a/README.md
+++ b/README.md
@@ -88,8 +88,9 @@ Configuration
-------------
Dotbot uses json-formatted configuration files to let you specify how to set up
-your dotfiles. Currently, Dotbot knows how to `link` files and execute `shell`
-commands. Dotbot executes tasks in the order that they are specified in.
+your dotfiles. Currently, Dotbot knows how to `link` files, execute `shell`
+commands, and `clean` directories of broken symbolic links. Dotbot executes
+tasks in the order that they are specified in.
**Ideally, bootstrap configurations should be idempotent. That is, the
installer should be able to be run multiple times without causing any
@@ -100,7 +101,8 @@ dictionary that contains a command name mapping to data for that command. For
`link`, you specify how files should be linked in a dictionary. For `shell`,
you specify an array consisting of commands, where each command is an array
consisting of the shell command as the first element and a description as the
-second.
+second. For `clean`, you specify an array consisting of targets, where each
+target is a path to a directory.
Dotbot is aware of a base directory (that is specified when running the
installer), so link targets can be specified relative to that, and shell
@@ -112,6 +114,9 @@ started. The convention for configuration file names is `install.conf.json`.
```json
[
{
+ "clean": ["~"]
+ },
+ {
"link": {
"~/.tmux.conf": "tmux.conf",
"~/.vimrc": "vimrc",