summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPieter van de Bruggen <pvande@gmail.com>2011-02-03 10:53:44 -0800
committerPieter van de Bruggen <pvande@gmail.com>2011-02-03 10:53:44 -0800
commit572b582e7c6ac0650785de930efbfe9633f7818d (patch)
tree463e57d184fdf1f7217b3e8a27583e0354e3ee1e /README.md
parent4ffb70f5117f404c87c69b9d60a95e8b38d5b298 (diff)
downloadmustache-spec-572b582e7c6ac0650785de930efbfe9633f7818d.tar.gz
Merge remote branch 'mrb/master'
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index 384b514..b767960 100644
--- a/README.md
+++ b/README.md
@@ -29,15 +29,17 @@ outside this core specification, as adjunct specifications.
Implementors are strongly encouraged to support any and all modules they are
reasonably capable of supporting.
-YAML and JSON
--------------
-
-JSON versions of the YML specs were created using a simple ruby script:
-
- require 'json' # Make sure you're using SYCK
- require 'yaml'
- Dir.glob("Mustache-Spec/specs/*").collect{|f| ff=f.gsub("yml","json"); File.open(ff,'w'){|x| x << YAML.parse(File.open(f)).transform.to_json}}
-
-Which has been included as a Rake task:
-
- rake build:json \ No newline at end of file
+Alternate Formats
+-----------------
+
+Since YAML is a reasonably complex format that not every language has good
+tools for working with, we are also providing JSON versions of the specs.
+These should be kept identical to the YAML specifications, but if you find the
+need to regenerate them, they can be trivially rebuilt by invoking `rake
+build`.
+
+It is also worth noting that some specifications (notably, the lambda module)
+rely on YAML "tags" to denote special types of data (e.g. source code). Since
+JSON offers no way to denote this, a special key ("__tag__") is injected with
+the name of the tag as its value. See `TESTING.md` for more information about
+handling tagged data.