From cd84653ff362d9b9a68120a5e5036dda67cb01ea Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 14 Aug 2013 12:53:12 +0200 Subject: [PATCH] fixed extension documentation --- extensions/composer/README.md | 23 +++++++++++------------ extensions/jui/README.md | 18 +++++++++--------- extensions/mutex/README.md | 16 +++++++--------- extensions/smarty/README.md | 19 +++++++++---------- extensions/twig/README.md | 14 +++++++------- 5 files changed, 43 insertions(+), 47 deletions(-) diff --git a/extensions/composer/README.md b/extensions/composer/README.md index 871d1e3..986fc6c 100644 --- a/extensions/composer/README.md +++ b/extensions/composer/README.md @@ -1,5 +1,5 @@ Yii 2.0 Public Preview - Composer Installer -====================== +=========================================== Thank you for choosing Yii - a high-performance component-based PHP framework. @@ -13,33 +13,32 @@ without prior notices. **Yii 2.0 is not ready for production use yet.** This is the yii2 composer installer. + Installation ----------------- +------------ This extension offers you enhanced composer handling for your yii2-project. It will therefor require you to use composer. ` -php composer.phar require yiisoft/yii2-composer * +php composer.phar require yiisoft/yii2-composer "*" ` *Note: You might have to run `php composer.phar selfupdate` before using this extension.* Usage & Documentation ------------ +--------------------- + This extensions allows you to hook to certain composer events and prepare your yii2-app for usage. After the package is installed, the composer.json file has to be modified to enable this extension. To see it in action take a look at the example apps in the repository: -[Basic](https://github.com/suralc/yii2/blob/master/apps/basic/composer.json#L27) -[Advanced](https://github.com/suralc/yii2/blob/extensions-readme/apps/advanced/composer.json) - -However it might be useful to read through the official composer [documentation](http://getcomposer.org/doc/articles/scripts.md) to understand what this extension can to for you and what it can't. - -You can also use this as an template to create your own composer additions to ease development and deployment of your app. - - +- [Basic](https://github.com/suralc/yii2/blob/master/apps/basic/composer.json#L27) +- [Advanced](https://github.com/suralc/yii2/blob/extensions-readme/apps/advanced/composer.json) +However it might be useful to read through the official composer [documentation](http://getcomposer.org/doc/articles/scripts.md) +to understand what this extension can do for you and what it can't. +You can also use this as a template to create your own composer additions to ease development and deployment of your app. diff --git a/extensions/jui/README.md b/extensions/jui/README.md index 6025ac4..0403acb 100644 --- a/extensions/jui/README.md +++ b/extensions/jui/README.md @@ -1,5 +1,5 @@ Yii 2.0 Public Preview - JUI Extension -====================== +====================================== Thank you for choosing Yii - a high-performance component-based PHP framework. @@ -13,13 +13,15 @@ without prior notices. **Yii 2.0 is not ready for production use yet.** This is the yii2-jui extension. + Installation ----------------- +------------ + The preferred way to install this extension is [composer](http://getcomposer.org/download/). Either run ``` -php composer.phar require yiisoft/yii2-jui* +php composer.phar require yiisoft/yii2-jui "*" ``` or add @@ -33,23 +35,21 @@ to the require section of your composer.json. 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(array( 'clientOptions' => array( 'value' => 75, ), )); +``` -For further instructions refer to the guide (once it is finished) - - - +For further instructions refer to the yii guide. diff --git a/extensions/mutex/README.md b/extensions/mutex/README.md index e3a697d..161ee8a 100644 --- a/extensions/mutex/README.md +++ b/extensions/mutex/README.md @@ -1,5 +1,5 @@ Yii 2.0 Public Preview - Mutex Extension -====================== +======================================== Thank you for choosing Yii - a high-performance component-based PHP framework. @@ -13,13 +13,15 @@ without prior notices. **Yii 2.0 is not ready for production use yet.** This is the yii2-mutex extension. + Installation ----------------- +------------ + The prefered way to install this extension is through [composer](http://getcomposer.org/download/). Either run ``` -php composer.phar require yiisoft/yii2-mutex * +php composer.phar require yiisoft/yii2-mutex "*" ``` or add @@ -33,12 +35,8 @@ to the require section of your composer.json. Usage & Documentation ------------ +--------------------- This component can be used to perform actions similar to the concept of [mutual exclusion](http://en.wikipedia.org/wiki/Mutual_exclusion). -For concrete examples and advanced usage refer to the guide. - - - - +For concrete examples and advanced usage refer to the yii guide. diff --git a/extensions/smarty/README.md b/extensions/smarty/README.md index c40226c..adf764f 100644 --- a/extensions/smarty/README.md +++ b/extensions/smarty/README.md @@ -1,5 +1,5 @@ Yii 2.0 Public Preview - Smarty View Renderer -====================== +============================================= Thank you for choosing Yii - a high-performance component-based PHP framework. @@ -13,13 +13,15 @@ without prior notices. **Yii 2.0 is not ready for production use yet.** 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 * +php composer.phar require yiisoft/yii2-smarty "*" ``` or add @@ -33,12 +35,13 @@ to the require section of your composer.json. 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: +Example: + ```php