summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCasey Rodarmor <casey@rodarmor.com>2016-11-18 15:59:55 -0800
committerAnish Athalye <me@anishathalye.com>2016-11-18 23:27:54 -0600
commit54346fa942945a90128e1b58310cdad43054f286 (patch)
tree3113f994a74ec702dab2a0cb181b8e385c8edc36 /README.md
parentb482cbda585848c0d5f5345711fe338e319c0adf (diff)
Mention in readme that ~ is null in YAML
This is a weird YAML gotcha, and it seems worth mentioning in the readme since Dotbot users are likely to run into it.
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6fbc687..5ce8461 100644
--- a/README.md
+++ b/README.md
@@ -151,6 +151,9 @@ do not have a defined ordering.
When writing nested constructs, keep in mind that YAML is whitespace-sensitive.
Following the formatting used in the examples is a good idea.
+Also, note that `~` in YAML is the same as `null` in JSON. If you want a single
+character string containing a tilde, make sure to enclose it in quotes: `'~'`
+
### Link
Link commands specify how files and directories should be symbolically linked.