Skip to content

Commit

Permalink
docs(readme): improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejpeters committed Aug 10, 2015
1 parent 7e1e1a9 commit 9bfa40e
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
yii2-plupload
=============
The plupload extension for the Yii2 framework
# yii2-plupload

Installation
------------
A [plupload](http://www.plupload.com/) extension for the Yii2 framework

## Installation

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
```sh
php composer.phar require --prefer-dist boundstate/yii2-plupload "*"
```

Expand All @@ -22,10 +21,10 @@ or add
to the require section of your `composer.json` file.


Usage
-----
## Usage

Once the extension is installed, simply use it in your code by :
Once the extension is installed, simply create an upload button with:

```php
<?= \boundstate\plupload\Plupload::widget(); ?>```
<?= \boundstate\plupload\Plupload::widget(); ?>
```

0 comments on commit 9bfa40e

Please sign in to comment.