Skip to content

Commit

Permalink
docs(README): add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zacksleo committed Jun 11, 2018
1 parent 50b1986 commit 70a6457
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,46 @@
[![Travis](https://img.shields.io/travis/zacksleo/yii2-metronic.svg)]()
[![Scrutinizer](https://img.shields.io/scrutinizer/g/zacksleo/yii2-metronic.svg)]()
[![Scrutinizer Coverage](https://img.shields.io/scrutinizer/coverage/g/zacksleo/yii2-metronic.svg)]()


## Quick Start

### Config composer.json

```
"repositories": {
"asset-packagist": {
"type": "composer",
"url": "https://asset-packagist.org"
}
}
```

### Install

```
composer require zacksleo/yii2-metronic
```

### Usage

+ ** For Layout **

```
use zacksleo\yii2\metronic\bundles\layouts\LayoutAsset;
LayoutAsset::register($this);
```

+ ** For Plugins **

```
use zacksleo\yii2\metronic\bundles\plugins\AnimateAsset;
AnimateAsset::register($this);
```

+ ** For Pages **

```
use zacksleo\yii2\metronic\bundles\pages\AboutAsset;
AboutAsset::register($this);
```
5 changes: 3 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"bower-asset/select2-bootstrap-theme": "^0.1.0-beta.10",
"bower-asset/simple-line-icons": "~2.3",
"bower-asset/animate.css": "^3.5",
"bower-asset/bootstrap-datepicker": "^1.6"
"bower-asset/bootstrap-datepicker": "^1.6",
"zacksleo/metronic": "^4.7.6"
},
"require-dev": {
"phpunit/phpunit": "~4.4"
Expand All @@ -46,4 +47,4 @@
"url": "https://asset-packagist.org"
}
]
}
}

1 comment on commit 70a6457

@zacksleo
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed #1

Please sign in to comment.