From 77f46ae2df8315ce8c116dab9b381f76ded067d8 Mon Sep 17 00:00:00 2001 From: feuzeu Date: Fri, 26 May 2017 02:59:56 -0400 Subject: [PATCH] Updated the README. --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d9ccbba..29aedb7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# jaxon-blade -Jaxon view renderer for Blade templates +Jaxon View for Blade +==================== + +Render Blade templates in Jaxon applications. + +Installation +------------ + +Install this package with Composer. + +```json +"require": { + "jaxon-php/jaxon-blade": "~2.0" +} +``` + +Usage +----- + +Foreach directory containing Blade templates, add an entry to the `app.views` section in the configuration. + +```php + 'app' => array( + 'views' => array( + 'demo' => array( + 'directory' => '/path/to/demo/views', + 'extension' => '.blade.php', + 'renderer' => 'blade', + ), + ), + ), +``` + +In the application classes, this is how to render a view in this directory. + +```php + $this->view()->render('/sub/dir/file'); +``` + +Read the [views documentation](https://www.jaxon-php.org/docs/armada/views.html) to learn more about views.