From da3880504eedc9c38618c94a422da77319dac2b9 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Sun, 3 Nov 2013 00:01:13 -0400 Subject: [PATCH] updated extension README files. --- extensions/composer/README.md | 2 -- extensions/jui/README.md | 46 +++++++---------------------- extensions/smarty/README.md | 67 ++++++++++++++--------------------------- extensions/twig/README.md | 69 +++++++++++++++---------------------------- 4 files changed, 57 insertions(+), 127 deletions(-) diff --git a/extensions/composer/README.md b/extensions/composer/README.md index ab13c08..d4ce101 100644 --- a/extensions/composer/README.md +++ b/extensions/composer/README.md @@ -1,8 +1,6 @@ Yii 2 Composer Installer ======================== -[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2) - This is the composer installer for Yii 2 extensions. It implements a new composer package type named `yii2-extension`, which should be used by all Yii 2 extensions if they are distributed as composer packages. diff --git a/extensions/jui/README.md b/extensions/jui/README.md index 260f69a..0d66828 100644 --- a/extensions/jui/README.md +++ b/extensions/jui/README.md @@ -1,17 +1,13 @@ -Yii 2.0 Public Preview - JUI Extension -====================================== +JUI Extension for Yii 2 +======================= -Thank you for choosing Yii - a high-performance component-based PHP framework. +This is the JQuery UI extension for Yii 2. It encapsulates JQuery UI widgets as Yii widgets, +and makes using JQuery UI widgets in Yii applications extremely easy. For example, the following +single line of code in a view file would render a JQuery UI DatePicker widget: -If you are looking for a production-ready PHP framework, please use -[Yii v1.1](https://github.com/yiisoft/yii). - -Yii 2.0 is still under heavy development. We may make significant changes -without prior notices. **Yii 2.0 is not ready for production use yet.** - -[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2) - -This is the yii2-jui extension. +```php + 'start']) ?> +``` Installation @@ -20,36 +16,16 @@ Installation The preferred way to install this extension is [composer](http://getcomposer.org/download/). Either run + ``` php composer.phar require yiisoft/yii2-jui "*" ``` or add + ``` "yiisoft/yii2-jui": "*" ``` -to the require section of your composer.json. - - -*Note: You might have to run `php composer.phar selfupdate`* - - -Usage & Documentation ---------------------- - -This extension provides multiple widgets to work with jquery.ui, as well as a set of compatible jquery.ui files. - -You can use these widgets in your view files after you have registered the corresponding assets. - -Example: - -```php -echo ProgressBar::widget([ - 'clientOptions' => [ - 'value' => 75, - ], -]); -``` -For further instructions refer to the yii guide. +to the require section of your `composer.json` file. diff --git a/extensions/smarty/README.md b/extensions/smarty/README.md index b73a507..06617f0 100644 --- a/extensions/smarty/README.md +++ b/extensions/smarty/README.md @@ -1,55 +1,15 @@ -Yii 2.0 Public Preview - Smarty View Renderer -============================================= +Smarty Extension for Yii 2 +========================== -Thank you for choosing Yii - a high-performance component-based PHP framework. +This extension provides a `ViewRender` that would allow you to use Smarty view template engine. -If you are looking for a production-ready PHP framework, please use -[Yii v1.1](https://github.com/yiisoft/yii). - -Yii 2.0 is still under heavy development. We may make significant changes -without prior notices. **Yii 2.0 is not ready for production use yet.** - -[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2) - -This is the yii2-smarty extension. - - -Installation ------------- - -The prefered way to install this extension is through [composer](http://getcomposer.org/download/). - -Either run -``` -php composer.phar require yiisoft/yii2-smarty "*" -``` - -or add -```json -"yiisoft/yii2-smarty": "*" -``` -to the require section of your composer.json. - - -*Note: You might have to run `php composer.phar selfupdate`* - - -Usage & Documentation ---------------------- - -This extension has to be registered prior to usage. -To enable this view renderer add it to the $rendereres property of your view object. - -Example: +To use this extension, simply add the following code in your application configuration: ```php - [ 'view' => [ - 'class' => 'yii\base\View', 'renderers' => [ 'tpl' => [ 'class' => 'yii\smarty\ViewRenderer', @@ -61,4 +21,21 @@ return [ ]; ``` -For further instructions refer to the related section in the yii guide. +Installation +------------ + +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +``` +php composer.phar require yiisoft/yii2-smarty "*" +``` + +or add + +```json +"yiisoft/yii2-smarty": "*" +``` + +to the require section of your composer.json. diff --git a/extensions/twig/README.md b/extensions/twig/README.md index 57342f7..18107bc 100644 --- a/extensions/twig/README.md +++ b/extensions/twig/README.md @@ -1,56 +1,17 @@ -Yii 2.0 Public Preview - Twig View Renderer -=========================================== +Twig Extension for Yii 2 +======================== -Thank you for choosing Yii - a high-performance component-based PHP framework. +This extension provides a `ViewRender` that would allow you to use Twig view template engine. -If you are looking for a production-ready PHP framework, please use -[Yii v1.1](https://github.com/yiisoft/yii). +To use this extension, simply add the following code in your application configuration: -Yii 2.0 is still under heavy development. We may make significant changes -without prior notices. **Yii 2.0 is not ready for production use yet.** - -[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2) - -This is the yii2-twig extension. - - -Installation ------------- - -The prefered way to install this extension is through [composer](http://getcomposer.org/download/). - -Either run -``` -php composer.phar require yiisoft/yii2-twig "*" -``` - -or add -``` -"yiisoft/yii2-twig": "*" -``` -to the require section of your composer.json. - - -*Note: You might have to run `php composer.phar selfupdate`* - - -Usage & Documentation ---------------------- - -This extension has to be registered prior to usage. -To enable this view renderer add it to the $rendereres property of your view object. - -Example: ```php - [ 'view' => [ - 'class' => 'yii\base\View', 'renderers' => [ - 'twig' => [ + 'tpl' => [ 'class' => 'yii\twig\ViewRenderer', //'cachePath' => '@runtime/Twig/cache', //'options' => [], /* Array of twig options */ @@ -61,4 +22,22 @@ return [ ]; ``` -For further instructions refer to the related section in the yii guide. + +Installation +------------ + +The preferred way to install this extension is through [composer](http://getcomposer.org/download/). + +Either run + +``` +php composer.phar require yiisoft/yii2-twig "*" +``` + +or add + +``` +"yiisoft/yii2-twig": "*" +``` + +to the require section of your composer.json.