fix: update README.md

Author: altynbek07

README.md

@@ -1 +1,53 @@
-# TODO
+# Yii2 Bridge Migrate Command
+
+If you cannot start `yii2-bridge/core` migrations using a terminal (especially if your project is on a shared hosting), install this package and start migrating via `php`.
+
+## Installation
+
+### Composer
+
+The preferred way to install this extension is through [Composer](http://getcomposer.org/).
+
+Either run: 
+```
+composer require yii2-bridge/migrate-command:^0.1
+```
+
+or add `"yii2-bridge/migrate-command": "^0.1"` to the require section of your `composer.json`
+
+### Using
+
+Add a module `Bridge\Migrate\Modules\Module` in the configuration file of the console application to the modules section of the admin module:
+
+```php
+'console' => [
+    ...    
+    'modules' => [
+        'admin' => [
+            'class' => \Bridge\Core\BridgeModule::class,
+            'modules' => [
+                'migrate' => [
+                    'class' => 'Bridge\Migrate\Modules\Module',
+                ],
+            ],
+            ...
+        ]
+    ],
+    ...
+]
+```
+
+To start the migration, just run the command:
+```
+php yii admin/migrate
+```
+
+---
+
+If you want to run migrations on a shared hosting, you can run as php script through cron.  
+For example for shared hosting PS.kz:
+![PS.kz](./images/ps.png)
+
+## Author
+
+[Altynbek Kazezov](https://github.com/altynbek07/), e-mail: [altynbek.kazezov.97@gmail.com](mailto:altynbek.kazezov.97@gmail.com)

composer.json

@@ -13,7 +13,7 @@
   "authors": [
     {
       "name": "Altynbek Kazezov",
-      "email": "altinbek__97@mail.ru",
+      "email": "altynbek.kazezov.97@gmail.com",
       "role": "Developer"
     }
   ],

images/ps.png

@@ -2,11 +2,16 @@
 
 namespace Bridge\Migrate\Modules;
 
+use yii\base\Module as BaseModule;
+
 /**
  * Class Module
  * @package Bridge\Migrate\Modules
  */
-class Module extends \yii\base\Module
+class Module extends BaseModule
 {
+    /**
+     * @var string $controllerNamespace
+     */
     public $controllerNamespace = 'Bridge\Migrate\Controllers';
 }

src/Module.php

@@ -3,13 +3,25 @@
 namespace Bridge\Migrate\Controllers;
 
 use yii\console\Controller;
+use yii\helpers\Console;
 use Yii;
 
+/**
+ * DefaultController
+ * @package Bridge\Migrate\Controllers
+ */
 class DefaultController extends Controller
 {
+    /**
+     * This action runs the migration commands for the `yii2-bridge/core` package.
+     *
+     * @link https://github.com/yii2-bridge/core
+     * @return void
+     */
     public function actionIndex()
     {
         $result = shell_exec(Yii::getAlias('@app') . '/vendor/bin/bridge-install');
-        echo $result;
+
+        $this->stdout($result . "\n", Console::FG_GREEN);
     }
 }