diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..73378c5 --- /dev/null +++ b/README.markdown @@ -0,0 +1,58 @@ +Mustache.php +============ + +A [Mustache](http://github.com/defunkt/mustache) implementation in PHP. + + +Usage +----- + +A quick example: + + render('Hello {{planet}}', array('planet' => 'World!')); + // "Hello World!" + ?> + + +And a more in-depth example--this is the canonical Mustache template: + + Hello {{name}} + You have just won ${{value}}! + {{#in_ca}} + Well, ${{taxed_value}}, after taxes. + {{/in_ca}} + + +Create a view object--which could also be an associative array, but those don't do functions quite as well: + + value - ($this->value * 0.4); + } + + public $in_ca = true; + } + ?> + + +And render it: + + render($template, $chris); + ?> + + +See Also +-------- + + * [Readme for the Ruby Mustache implementation](http://github.com/defunkt/mustache/blob/master/README.md). + * [mustache(1)](http://defunkt.github.com/mustache/mustache.1.html) and [mustache(5)](http://defunkt.github.com/mustache/mustache.5.html) man pages. \ No newline at end of file