Clean up readme

This commit is contained in:
Dmitriy Simushev 2014-12-12 14:50:14 +00:00
parent e341787d48
commit 1fb5ae8cd9

View File

@ -1,4 +1,4 @@
# Handlebars.php Helpers Set # Handlebars.php Helpers
Provides a set of helpers for [Handlebars.php](https://github.com/XaminProject/handlebars.php) template engine. Provides a set of helpers for [Handlebars.php](https://github.com/XaminProject/handlebars.php) template engine.
@ -16,8 +16,8 @@ To use all helpers in your templates just create an instance of helpers set and
attach it to Handlebars engine. attach it to Handlebars engine.
```php ```php
$helpers = new \JustBlackBird\HandlebarsHelpers\Helpers(); $helpers = new \JustBlackBird\HandlebarsHelpers\Helpers();
$engine = new \Handlebars\Handlebars(array('helpers' => $helpers)); $engine = new \Handlebars\Handlebars(array('helpers' => $helpers));
``` ```
Want to use only subset of helpers? Fine. Just create an instance of appropriate Want to use only subset of helpers? Fine. Just create an instance of appropriate
@ -25,19 +25,19 @@ helpers set and attach it to Handlebars engine. Here is an example for Date
helpers: helpers:
```php ```php
$helpers = new \JustBlackBird\HandlebarsHelpers\Date\Helpers(); $helpers = new \JustBlackBird\HandlebarsHelpers\Date\Helpers();
$engine = new \Handlebars\Handlebars(array('helpers' => $helpers)); $engine = new \Handlebars\Handlebars(array('helpers' => $helpers));
``` ```
Want to use only chosen helpers? No problem. Just add them manually to your Want to use only chosen helpers? No problem. Just add them manually to your
helpers set: helpers set:
```php ```php
$engine = new \Handlebars\Handlebars(); $engine = new \Handlebars\Handlebars();
$engine->getHelpers()->add( $engine->getHelpers()->add(
'ifEqual', 'ifEqual',
new \JustBlackBird\HandlebarsHelpers\Comparison\IfEqualHelper() new \JustBlackBird\HandlebarsHelpers\Comparison\IfEqualHelper()
); );
``` ```