Browse Source

improved extensions readme

tags/2.0.3
Carsten Brandt 10 years ago
parent
commit
8dc0965661
  1. 25
      README.md

25
README.md

@ -1,15 +1,13 @@
Twitter Bootstrap Extension for Yii 2
=====================================
This is the Twitter Bootstrap extension for Yii 2. It encapsulates Bootstrap components
This is the Twitter Bootstrap extension for Yii 2. It encapsulates [Bootstrap](http://getbootstrap.com/) components
and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins
in Yii applications extremely easy. For example, the following
single line of code in a view file would render a Bootstrap Progress plugin:
```php
<?= yii\bootstrap\Progress::widget(['percent' => 60, 'label' => 'test']) ?>
```
in Yii applications extremely easy.
This repository is a git submodule of <https://github.com/yiisoft/yii2>.
Please submit issue reports and pull requests to the main repository.
For license information check the [LICENSE](LICENSE.md)-file.
Installation
------------
@ -19,14 +17,23 @@ The preferred way to install this extension is through [composer](http://getcomp
Either run
```
php composer.phar require --prefer-dist yiisoft/yii2-bootstrap "*"
php composer.phar require --prefer-dist yiisoft/yii2-bootstrap
```
or add
```
"yiisoft/yii2-bootstrap": "*"
"yiisoft/yii2-bootstrap": "~2.0.0"
```
to the require section of your `composer.json` file.
Usage
----
For example, the following
single line of code in a view file would render a Bootstrap Progress plugin:
```php
<?= yii\bootstrap\Progress::widget(['percent' => 60, 'label' => 'test']) ?>
```

Loading…
Cancel
Save