From 4f97fced0fa93b2d95da3f890ea457b3095637e2 Mon Sep 17 00:00:00 2001 From: Suralc Date: Thu, 11 Jul 2013 16:33:47 +0200 Subject: [PATCH 1/2] Added readme and license files to extensions. --- extensions/composer/LICENSE.md | 32 +++++++++++++++++++++ extensions/composer/README.md | 45 +++++++++++++++++++++++++++++ extensions/jui/LICENSE.md | 32 +++++++++++++++++++++ extensions/jui/README.md | 55 +++++++++++++++++++++++++++++++++++ extensions/mutex/LICENSE.md | 32 +++++++++++++++++++++ extensions/mutex/README.md | 44 ++++++++++++++++++++++++++++ extensions/smarty/LICENSE.md | 32 +++++++++++++++++++++ extensions/smarty/README.md | 65 ++++++++++++++++++++++++++++++++++++++++++ extensions/twig/LICENSE.md | 32 +++++++++++++++++++++ extensions/twig/README.md | 64 +++++++++++++++++++++++++++++++++++++++++ 10 files changed, 433 insertions(+) create mode 100644 extensions/composer/LICENSE.md create mode 100644 extensions/composer/README.md create mode 100644 extensions/jui/LICENSE.md create mode 100644 extensions/jui/README.md create mode 100644 extensions/mutex/LICENSE.md create mode 100644 extensions/mutex/README.md create mode 100644 extensions/smarty/LICENSE.md create mode 100644 extensions/smarty/README.md create mode 100644 extensions/twig/LICENSE.md create mode 100644 extensions/twig/README.md diff --git a/extensions/composer/LICENSE.md b/extensions/composer/LICENSE.md new file mode 100644 index 0000000..0bb1a8d --- /dev/null +++ b/extensions/composer/LICENSE.md @@ -0,0 +1,32 @@ +The Yii framework is free software. It is released under the terms of +the following BSD License. + +Copyright © 2008-2013 by Yii Software LLC (http://www.yiisoft.com) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii Software LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/extensions/composer/README.md b/extensions/composer/README.md new file mode 100644 index 0000000..7fdb6e1 --- /dev/null +++ b/extensions/composer/README.md @@ -0,0 +1,45 @@ +Yii 2.0 Public Preview - Composer Installer +====================== + +Thank you for choosing Yii - a high-performance component-based PHP framework. + +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 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 * +` + +*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 you have to modify your composer.json 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. + + + + diff --git a/extensions/jui/LICENSE.md b/extensions/jui/LICENSE.md new file mode 100644 index 0000000..0bb1a8d --- /dev/null +++ b/extensions/jui/LICENSE.md @@ -0,0 +1,32 @@ +The Yii framework is free software. It is released under the terms of +the following BSD License. + +Copyright © 2008-2013 by Yii Software LLC (http://www.yiisoft.com) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii Software LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/extensions/jui/README.md b/extensions/jui/README.md new file mode 100644 index 0000000..2a478eb --- /dev/null +++ b/extensions/jui/README.md @@ -0,0 +1,55 @@ +Yii 2.0 Public Preview - JUI Extension +====================== + +Thank you for choosing Yii - a high-performance component-based PHP framework. + +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. + +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 the 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) + + + + diff --git a/extensions/mutex/LICENSE.md b/extensions/mutex/LICENSE.md new file mode 100644 index 0000000..0bb1a8d --- /dev/null +++ b/extensions/mutex/LICENSE.md @@ -0,0 +1,32 @@ +The Yii framework is free software. It is released under the terms of +the following BSD License. + +Copyright © 2008-2013 by Yii Software LLC (http://www.yiisoft.com) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii Software LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/extensions/mutex/README.md b/extensions/mutex/README.md new file mode 100644 index 0000000..e3a697d --- /dev/null +++ b/extensions/mutex/README.md @@ -0,0 +1,44 @@ +Yii 2.0 Public Preview - Mutex Extension +====================== + +Thank you for choosing Yii - a high-performance component-based PHP framework. + +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-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 * +``` + +or add +``` +"yiisoft/yii2-mutex": "*" +``` +to the require section of your composer.json. + + +*Note: You might have to run `php composer.phar selfupdate`* + + +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. + + + + diff --git a/extensions/smarty/LICENSE.md b/extensions/smarty/LICENSE.md new file mode 100644 index 0000000..0bb1a8d --- /dev/null +++ b/extensions/smarty/LICENSE.md @@ -0,0 +1,32 @@ +The Yii framework is free software. It is released under the terms of +the following BSD License. + +Copyright © 2008-2013 by Yii Software LLC (http://www.yiisoft.com) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii Software LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/extensions/smarty/README.md b/extensions/smarty/README.md new file mode 100644 index 0000000..927d96c --- /dev/null +++ b/extensions/smarty/README.md @@ -0,0 +1,65 @@ +Yii 2.0 Public Preview - Smarty View Renderer +====================== + +Thank you for choosing Yii - a high-performance component-based PHP framework. + +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 do this add the following to the $rendereres property of the view instance you want to use this with: + +Example: +```php + array( + 'view' => array( + 'class' => 'yii\base\View', + 'viewRenderers' => array( + 'tpl' => array( + 'class' => 'yii\smarty\ViewRenderer', + //'cachePath' => '@runtime/Smarty/cache', + ), + ), + ), + ), +); +``` + +For further instructions refer to the related section in the guide. + + + + diff --git a/extensions/twig/LICENSE.md b/extensions/twig/LICENSE.md new file mode 100644 index 0000000..0bb1a8d --- /dev/null +++ b/extensions/twig/LICENSE.md @@ -0,0 +1,32 @@ +The Yii framework is free software. It is released under the terms of +the following BSD License. + +Copyright © 2008-2013 by Yii Software LLC (http://www.yiisoft.com) +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Yii Software LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/extensions/twig/README.md b/extensions/twig/README.md new file mode 100644 index 0000000..d1ad873 --- /dev/null +++ b/extensions/twig/README.md @@ -0,0 +1,64 @@ +Yii 2.0 Public Preview - Twig View Renderer +====================== + +Thank you for choosing Yii - a high-performance component-based PHP framework. + +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-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 do this add the following to the $rendereres property of the view instance you want to use this with: + +Example: +```php + array( + 'view' => array( + 'class' => 'yii\base\View', + 'viewRenderers' => array( + 'twig' => array( + 'class' => 'yii\twig\ViewRenderer', + //'cachePath' => '@runtime/Twig/cache', + //'options' => array(), /* Array of twig options */ + ), + ), + ), + ), +); +``` + +For further instructions refer to the related section in the guide. + + From ce9fabab57073fe6621316595037942430f7fe75 Mon Sep 17 00:00:00 2001 From: Suralc Date: Thu, 11 Jul 2013 17:22:43 +0200 Subject: [PATCH 2/2] Rewording --- extensions/composer/README.md | 2 +- extensions/jui/README.md | 2 +- extensions/smarty/README.md | 2 +- extensions/twig/README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/extensions/composer/README.md b/extensions/composer/README.md index 7fdb6e1..871d1e3 100644 --- a/extensions/composer/README.md +++ b/extensions/composer/README.md @@ -29,7 +29,7 @@ Usage & Documentation ----------- This extensions allows you to hook to certain composer events and prepare your yii2-app for usage. -After the package is installed you have to modify your composer.json to enable this extension. +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: diff --git a/extensions/jui/README.md b/extensions/jui/README.md index 2a478eb..6025ac4 100644 --- a/extensions/jui/README.md +++ b/extensions/jui/README.md @@ -35,7 +35,7 @@ to the require section of your composer.json. Usage & Documentation ----------- -This extension provides the multiple widgets to work with jquery.ui, as well as a set of compatible jquery.ui files. +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. diff --git a/extensions/smarty/README.md b/extensions/smarty/README.md index 927d96c..45115ef 100644 --- a/extensions/smarty/README.md +++ b/extensions/smarty/README.md @@ -36,7 +36,7 @@ Usage & Documentation ----------- This extension has to be registered prior to usage. -To do this add the following to the $rendereres property of the view instance you want to use this with: +To enable this view renderer add it to the $rendereres property of your view object. Example: ```php diff --git a/extensions/twig/README.md b/extensions/twig/README.md index d1ad873..037f0e9 100644 --- a/extensions/twig/README.md +++ b/extensions/twig/README.md @@ -36,7 +36,7 @@ Usage & Documentation ----------- This extension has to be registered prior to usage. -To do this add the following to the $rendereres property of the view instance you want to use this with: +To enable this view renderer add it to the $rendereres property of your view object. Example: ```php