Merge pull request #467 from jcsahnwaldt/patch-1

README.md: describe builder options attrkey and charkey
Leonidas-from-XIV · Jun 15, 2018 · 66bcb29 · 66bcb29
2 parents cec9dc0 + c1d49d8
commit 66bcb29
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -373,6 +373,10 @@ Options for the `Builder` class
 These options are specified by ``new Builder({optionName: value})``.
 Possible options are:
 
+  * `attrkey` (default: `$`): Prefix that is used to access the attributes.
+    Version 0.1 default was `@`.
+  * `charkey` (default: `_`): Prefix that is used to access the character
+    content. Version 0.1 default was `#`.
   * `rootName` (default `root` or the root key name): root element name to be used in case
      `explicitRoot` is `false` or to override the root element name.
   * `renderOpts` (default `{ 'pretty': true, 'indent': '  ', 'newline': '\n' }`):