Upd README.md

Author: rkit

README.md

@@ -0,0 +1,100 @@
+# Settings for Yii2
+
+[![Build Status](https://travis-ci.org/rkit/settings-yii2.svg?branch=master)](https://travis-ci.org/rkit/settings-yii2)
+[![Code Coverage](https://scrutinizer-ci.com/g/rkit/settings-yii2/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/rkit/settings-yii2/?branch=master)
+[![codecov.io](http://codecov.io/github/rkit/settings-yii2/coverage.svg?branch=master)](http://codecov.io/github/rkit/settings-yii2?branch=master)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/rkit/settings-yii2/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/rkit/settings-yii2/?branch=master)
+
+## Installation
+
+1. Installing using Composer
+   ```
+   composer require rkit/settings-yii2
+   ```
+
+2. Run migrations
+   ```
+   php yii migrate --migrationPath=@vendor/rkit/settings-yii2/src/migrations/ --interactive=0
+   ```
+
+## Configuration
+
+Add the following in your config, in section `components`
+
+```php
+'settings' => [
+      'class' => 'rkit\settings\Settings',
+      //'cache' => '…', // cache component name
+      //'tableName' => '…' // table name
+      //'cacheName' => '…' // a key identifying the values to be cached
+ ]
+```
+
+## Usage
+
+### Basic usage
+
+1. Load
+   ```php
+   Yii::$app->settings->load(['key' => 'value']);
+   ```
+
+2. Set
+   ```php
+   Yii::$app->settings->set('key', 'value');
+   // or
+   Yii::$app->settings->key = value;
+   ```
+
+3. Get
+   ```php
+   Yii::$app->settings->get('key');
+   // or
+   Yii::$app->settings->key;
+   // get all
+   Yii::$app->settings->all();
+   ```
+
+### Editing in the control panel
+
+1. Controller
+   ```php
+   $model = new Settings();
+
+    if (Yii::$app->request->isPost) {
+         if ($model->load(Yii::$app->request->post()) && $model->validate()) {
+             Yii::$app->settings->load($model->getAttributes());
+             Yii::$app->session->setFlash('success', Yii::t('app', 'Saved successfully'));
+             return $this->refresh();
+         }
+    }
+
+    $model->setAttributes(Yii::$app->settings->all());
+
+    return $this->render('index', ['model' => $model]);
+   ```
+
+2. Model
+   ```php
+   class Settings extends \yii\base\Model
+   {
+      …
+      public function rules()
+      {
+          return [
+              ['emailPrefix', 'trim'],
+              ['emailMain', 'email'],
+              …
+          ];
+      }
+      …
+   }
+   ```
+
+3. View
+   ```php
+   …
+   <?= $form->field($model, 'emailMain') ?>
+   <?= $form->field($model, 'emailPrefix') ?>
+   …
+   ```