diff options
| author | kpdecker <kpdecker@gmail.com> | 2014-08-14 00:43:46 -0500 |
|---|---|---|
| committer | kpdecker <kpdecker@gmail.com> | 2014-08-14 00:48:19 -0500 |
| commit | 1bd8d38c3c3402767584d40bef49988f101a7aa9 (patch) | |
| tree | af5f3e67a325a2ab44e210d9d1b773a4f93a461a | |
| parent | 59607aa9ab4f93683b372777fa03cb07ba5b7db7 (diff) | |
| download | handlebars.js-1bd8d38c3c3402767584d40bef49988f101a7aa9.zip handlebars.js-1bd8d38c3c3402767584d40bef49988f101a7aa9.tar.gz handlebars.js-1bd8d38c3c3402767584d40bef49988f101a7aa9.tar.bz2 | |
Update compatibility documentation
Provides an official statement regarding the issues discussed in #425
| -rw-r--r-- | README.markdown | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 4820629..866661e 100644 --- a/README.markdown +++ b/README.markdown @@ -338,6 +338,14 @@ rewritten Handlebars (current version) is faster than the old version, and we will have some benchmarks in the near future. +Mustache Compatibilty +--------------------- + +Handlebars deviates from the Mustache spec in a few key ways: +- Alternative delimeters are not supported +- Recrusive value lookup is not enabled by default. The compile time `compat` flag must be set to enable this functionality. Users should note that there is a performance cost for enabling this flag. The exact cost varies by template, but it's recommended that performance sensitive operations should avoid this mode and instead opt for explicit path references. +- The optional Mustache-style lambdas are not supported. Instead Handlebars provides it's own lambda resolution that follows the behaviors of helpers. + Building -------- |