diff options
author | Anish Athalye <me@anishathalye.com> | 2016-01-11 13:33:31 -0500 |
---|---|---|
committer | Anish Athalye <me@anishathalye.com> | 2016-01-11 13:36:16 -0500 |
commit | 57265f78b4e4f6ca67393f55b2b08f6f45a02ff1 (patch) | |
tree | 844ef17fec750afbc599b0c3745570045b2fc51c /README.md | |
parent | 5babc8f562f9ba1ad3e78b5ec6906aa33d17c0a9 (diff) |
Add note to README about JSON parsing
Casey Rodarmor <casey@rodarmor.com> 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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 15 |
1 files changed, 10 insertions, 5 deletions
@@ -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 |