From 57265f78b4e4f6ca67393f55b2b08f6f45a02ff1 Mon Sep 17 00:00:00 2001 From: Anish Athalye Date: Mon, 11 Jan 2016 13:33:31 -0500 Subject: [PATCH] Add note to README about JSON parsing Casey Rodarmor pointed out that Dotbot parses JSON files as YAML. The YAML format doesn't allow tab characters, which are normally allowed in JSON. This patch adds a note about this to the README. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6b7f288..f1d1128 100644 --- a/README.md +++ b/README.md @@ -109,12 +109,17 @@ The conventional name for this file is `install.conf.json`. ] ``` -## Configuration +Configuration +------------- -Dotbot uses YAML or JSON formatted configuration files to let you specify how to -set up your dotfiles. Currently, Dotbot knows how to [link](#link) files and -folders, execute [shell](#shell) commands, and [clean](#clean) directories of -broken symbolic links. +Dotbot uses YAML or JSON formatted configuration files to let you specify how +to set up your dotfiles. The YAML format is recommended because it looks +cleaner. JSON will be parsed as a subset of YAML, so tab characters are not +permitted. + +Currently, Dotbot knows how to [link](#link) files and folders, execute +[shell](#shell) commands, and [clean](#clean) directories of broken symbolic +links. **Ideally, bootstrap configurations should be idempotent. That is, the installer should be able to be run multiple times without causing any