Document options.sortKeys for dumper

rjmunro · rjmunro · commit febe46534edf · 2015-05-08T15:58:35.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+Unreleased
+----------
+
+- Allow options.sortKeys to specify that keys should be sorted when dumping, to
+enable deterministic output.
+
 3.3.0 / 2015-04-26
 ------------------
 
diff --git a/README.md b/README.md
@@ -175,6 +175,8 @@ options:
   block to flow style for collections. -1 means block style everwhere
 - `styles` - "tag" => "style" map. Each tag may have own set of styles.
 - `schema` _(default: `DEFAULT_SAFE_SCHEMA`)_ specifies a schema to use.
+- `sortKeys` _(default: `false`)_ - if `true`, sort keys when dumping YAML. If a
+  function, use the function to sort the keys.
 
 styles:
 
