README.md
Models for Yii 2
================
The Models for Yii 2 Applications
[![Latest Stable Version](https://poser.pugx.org/vistart/yii2-models/v/stable.png)](https://packagist.org/packages/vistart/yii2-models)
[![License](https://poser.pugx.org/vistart/yii2-models/license)](https://packagist.org/packages/vistart/yii2-models)
[![Reference Status](https://www.versioneye.com/php/vistart:yii2-models/reference_badge.svg)](https://www.versioneye.com/php/vistart:yii2-models/references)
[![Build Status](https://img.shields.io/travis/vistart/yii2-models.svg)](http://travis-ci.org/vistart/yii2-models)
[![Dependency Status](https://www.versioneye.com/php/vistart:yii2-models/dev-master/badge.png)](https://www.versioneye.com/php/vistart:yii2-models/dev-master)
[![Code Coverage](https://scrutinizer-ci.com/g/vistart/yii2-models/badges/coverage.png)](https://scrutinizer-ci.com/g/vistart/yii2-models/)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/vistart/yii2-models/badges/quality-score.png)](https://scrutinizer-ci.com/g/vistart/yii2-models/)
[![Code Climate](https://img.shields.io/codeclimate/github/vistart/yii2-models.svg)](https://codeclimate.com/github/vistart/yii2-models)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist vistart/yii2-models "*"
```
or add
```
"vistart/yii2-models": "*"
```
to the require section of your `composer.json` file.
If you want to use Redis or MongoDB ActiveRecord, please add
```
"yiisoft/yii2-redis": "*"
```
or
```
"yiisoft/yii2-mongodb": "*"
```
to the require section of your `composer.json` file by yourself.
Usage
-----
Once the extension is installed, simply use it in your code by :
```php
use vistart\Models\models\BaseEntityModel;
class Example extends BaseEntityModel
{
...
}
```
further detailed usage seen in code file notes.
Contact Us
----------
[![Join the chat at https://gitter.im/vistart/yii2-models](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vistart/yii2-models?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
If you have any problems or good ideas about yii2-models, please discuss there, or send an email to i@vistart.name. Thank you!
If you want to send an email with your issues, please briefly introduce yourself first, for instance including your title and github homepage.
[![yii2-models](https://img.shields.io/badge/Powered_by-vistart-green.svg?style=flat)](https://vistart.name)