From b4549f3a54dff012f463274e4e1a41a448c2ffe7 Mon Sep 17 00:00:00 2001
From: resurtm <resurtm@gmail.com>
Date: Sun, 18 Dec 2016 23:29:58 +0600
Subject: [PATCH] documentation wip

---
 README.md                  | 45 ++++++--------------------------------
 docs/README.md             |  5 +++++
 docs/media/cogs.svg        |  1 +
 docs/media/information.md  | 17 ++++++++++++++
 docs/media/user-secret.svg |  1 +
 docs/media/wrench.svg      |  1 +
 docs/media/yii-logo.svg    | 33 ++++++++++++++++++++++++++++
 7 files changed, 65 insertions(+), 38 deletions(-)
 create mode 100644 docs/media/cogs.svg
 create mode 100644 docs/media/information.md
 create mode 100644 docs/media/user-secret.svg
 create mode 100644 docs/media/wrench.svg
 create mode 100644 docs/media/yii-logo.svg

diff --git a/README.md b/README.md
index aff25f2..2f7fb31 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,9 @@
-Migrations
-==========
+Yii2 User
+=========
 
-Add the following settings to your console application configuration file:
+![](./docs/media/yii-logo.svg "")
+![](./docs/media/user-secret.svg "")
+![](./docs/media/wrench.svg "")
+![](./docs/media/cogs.svg "")
 
-```php
-return [
-    // ...
-    'controllerMap' => [
-        'migrate' => [
-            'class' => \yii\console\controllers\MigrateController::class,
-            'migrationNamespaces' => [
-                'Da\User\Migration',
-            ],
-        ],
-    ],
-    // ...
-];
-```
-
-This will allow you to run only a single console command:
-
-```
-./yii migrate
-```
-
-It prevents you from manual tracking of new migrations coming from our extension. What if we would add a new migration class, and you forgot to run appropriate console command to launch them?
-
-Without namespaced migrations it would be:
-
-```
-./yii migrate
-./yii migrate --migrationPath="@Da/User/resources/migrations"
-```
-
-Without namespaced migrations it's just:
-
-```
-./yii migrate
-```
+© [2amigos](http://www.2amigos.us/) 2016
diff --git a/docs/README.md b/docs/README.md
index 116bdd0..82e13a6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,11 @@
 Yii2 User Module Documentation
 ==============================
 
+![](./media/yii-logo.svg "")
+![](./media/user-secret.svg "")
+![](./media/wrench.svg "")
+![](./media/cogs.svg "")
+
 © [2amigos](http://www.2amigos.us/) 2016
 
 Installation
diff --git a/docs/media/cogs.svg b/docs/media/cogs.svg
new file mode 100644
index 0000000..e7f37a9
--- /dev/null
+++ b/docs/media/cogs.svg
@@ -0,0 +1 @@
+<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M832 896q0-106-75-181t-181-75-181 75-75 181 75 181 181 75 181-75 75-181zm768 512q0-52-38-90t-90-38-90 38-38 90q0 53 37.5 90.5t90.5 37.5 90.5-37.5 37.5-90.5zm0-1024q0-52-38-90t-90-38-90 38-38 90q0 53 37.5 90.5t90.5 37.5 90.5-37.5 37.5-90.5zm-384 421v185q0 10-7 19.5t-16 10.5l-155 24q-11 35-32 76 34 48 90 115 7 10 7 20 0 12-7 19-23 30-82.5 89.5t-78.5 59.5q-11 0-21-7l-115-90q-37 19-77 31-11 108-23 155-7 24-30 24h-186q-11 0-20-7.5t-10-17.5l-23-153q-34-10-75-31l-118 89q-7 7-20 7-11 0-21-8-144-133-144-160 0-9 7-19 10-14 41-53t47-61q-23-44-35-82l-152-24q-10-1-17-9.5t-7-19.5v-185q0-10 7-19.5t16-10.5l155-24q11-35 32-76-34-48-90-115-7-11-7-20 0-12 7-20 22-30 82-89t79-59q11 0 21 7l115 90q34-18 77-32 11-108 23-154 7-24 30-24h186q11 0 20 7.5t10 17.5l23 153q34 10 75 31l118-89q8-7 20-7 11 0 21 8 144 133 144 160 0 9-7 19-12 16-42 54t-45 60q23 48 34 82l152 23q10 2 17 10.5t7 19.5zm640 533v140q0 16-149 31-12 27-30 52 51 113 51 138 0 4-4 7-122 71-124 71-8 0-46-47t-52-68q-20 2-30 2t-30-2q-14 21-52 68t-46 47q-2 0-124-71-4-3-4-7 0-25 51-138-18-25-30-52-149-15-149-31v-140q0-16 149-31 13-29 30-52-51-113-51-138 0-4 4-7 4-2 35-20t59-34 30-16q8 0 46 46.5t52 67.5q20-2 30-2t30 2q51-71 92-112l6-2q4 0 124 70 4 3 4 7 0 25-51 138 17 23 30 52 149 15 149 31zm0-1024v140q0 16-149 31-12 27-30 52 51 113 51 138 0 4-4 7-122 71-124 71-8 0-46-47t-52-68q-20 2-30 2t-30-2q-14 21-52 68t-46 47q-2 0-124-71-4-3-4-7 0-25 51-138-18-25-30-52-149-15-149-31v-140q0-16 149-31 13-29 30-52-51-113-51-138 0-4 4-7 4-2 35-20t59-34 30-16q8 0 46 46.5t52 67.5q20-2 30-2t30 2q51-71 92-112l6-2q4 0 124 70 4 3 4 7 0 25-51 138 17 23 30 52 149 15 149 31z"/></svg>
\ No newline at end of file
diff --git a/docs/media/information.md b/docs/media/information.md
new file mode 100644
index 0000000..ab06171
--- /dev/null
+++ b/docs/media/information.md
@@ -0,0 +1,17 @@
+Yii Logo
+========
+
+File `yii-logo.svg`:  
+[Yii Framework logo download](http://www.yiiframework.com/logo/)
+
+Font Awesome icons
+==================
+
+File `cogs.svg`:  
+[Github project: encharm/Font-Awesome-SVG-PNG](https://github.com/encharm/Font-Awesome-SVG-PNG/blob/master/black/svg/cogs.svg)
+
+File `user-secret.svg:  
+[Github project: encharm/Font-Awesome-SVG-PNG](https://github.com/encharm/Font-Awesome-SVG-PNG/blob/master/black/svg/user-secret.svg)
+
+File `wrench.svg`:  
+[Github project: encharm/Font-Awesome-SVG-PNG](https://github.com/encharm/Font-Awesome-SVG-PNG/blob/master/black/svg/wrench.svg)
diff --git a/docs/media/user-secret.svg b/docs/media/user-secret.svg
new file mode 100644
index 0000000..dfb39f6
--- /dev/null
+++ b/docs/media/user-secret.svg
@@ -0,0 +1 @@
+<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M704 1536l96-448-96-128-128-64zm256 0l128-640-128 64-96 128zm160-1010q-2-4-4-6-10-8-96-8-70 0-167 19-7 2-21 2t-21-2q-97-19-167-19-86 0-96 8-2 2-4 6 2 18 4 27 2 3 7.5 6.5t7.5 10.5q2 4 7.5 20.5t7 20.5 7.5 17 8.5 17 9 14 12 13.5 14 9.5 17.5 8 20.5 4 24.5 2q36 0 59-12.5t32.5-30 14.5-34.5 11.5-29.5 17.5-12.5h12q11 0 17.5 12.5t11.5 29.5 14.5 34.5 32.5 30 59 12.5q13 0 24.5-2t20.5-4 17.5-8 14-9.5 12-13.5 9-14 8.5-17 7.5-17 7-20.5 7.5-20.5q2-7 7.5-10.5t7.5-6.5q2-9 4-27zm416 879q0 121-73 190t-194 69h-874q-121 0-194-69t-73-190q0-61 4.5-118t19-125.5 37.5-123.5 63.5-103.5 93.5-74.5l-90-220h214q-22-64-22-128 0-12 2-32-194-40-194-96 0-57 210-99 17-62 51.5-134t70.5-114q32-37 76-37 30 0 84 31t84 31 84-31 84-31q44 0 76 37 36 42 70.5 114t51.5 134q210 42 210 99 0 56-194 96 7 81-20 160h214l-82 225q63 33 107.5 96.5t65.5 143.5 29 151.5 8 148.5z"/></svg>
\ No newline at end of file
diff --git a/docs/media/wrench.svg b/docs/media/wrench.svg
new file mode 100644
index 0000000..a55a15f
--- /dev/null
+++ b/docs/media/wrench.svg
@@ -0,0 +1 @@
+<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M448 1472q0-26-19-45t-45-19-45 19-19 45 19 45 45 19 45-19 19-45zm644-420l-682 682q-37 37-90 37-52 0-91-37l-106-108q-38-36-38-90 0-53 38-91l681-681q39 98 114.5 173.5t173.5 114.5zm634-435q0 39-23 106-47 134-164.5 217.5t-258.5 83.5q-185 0-316.5-131.5t-131.5-316.5 131.5-316.5 316.5-131.5q58 0 121.5 16.5t107.5 46.5q16 11 16 28t-16 28l-293 169v224l193 107q5-3 79-48.5t135.5-81 70.5-35.5q15 0 23.5 10t8.5 25z"/></svg>
\ No newline at end of file
diff --git a/docs/media/yii-logo.svg b/docs/media/yii-logo.svg
new file mode 100644
index 0000000..5e29e84
--- /dev/null
+++ b/docs/media/yii-logo.svg
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="256px" height="274px" viewBox="0 0 256 274" version="1.1" xmlns="http://www.w3.org/2000/svg"
+     xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid">
+    <defs>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
+            <stop stop-color="#73B723" offset="0%"></stop>
+            <stop stop-color="#D8EE61" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="84.857945%" y1="26.2510333%" x2="13.5844148%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#98C9EA" offset="0%"></stop>
+            <stop stop-color="#026FB2" offset="68.8649011%"></stop>
+            <stop stop-color="#086EB6" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="0%" y1="6.32032406%" x2="85.8842047%" y2="69.934521%" id="linearGradient-3">
+            <stop stop-color="#D73721" offset="0%"></stop>
+            <stop stop-color="#F7D768" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="30.9607463%" y1="30.9929036%" x2="86.77032%" y2="81.7463136%" id="linearGradient-4">
+            <stop stop-color="#D4C883" offset="0%"></stop>
+            <stop stop-color="#A1D1A7" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g>
+        <path d="M221.82887,0.00412799194 C240.429601,9.48199748 256.40493,34.3531489 255.6041,68.103611 C253.172713,109.689002 223.021859,145.528228 190.216707,178.548035 C188.379751,138.279474 179.62428,112.615748 165.952371,76.5288425 C153.04414,40.1612336 190.782242,1.16822172 221.82887,0.00412799194 Z"
+              fill="url(#linearGradient-1)"></path>
+        <path d="M121.217322,177.132134 C131.204902,164.708201 138.283655,153.644222 143.224024,143.647838 C177.064816,161.34127 169.079363,158.037037 185.400361,176.888462 C185.455453,177.47466 185.507406,178.05952 185.556205,178.642979 C186.910186,204.781424 167.842991,265.20697 92.7630738,273.487722 C87.565932,232.884793 104.461803,198.250941 121.217322,177.132134 Z"
+              fill="url(#linearGradient-2)"></path>
+        <path d="M0.390998236,25.2467987 C53.8856458,4.07845603 111.458749,25.7627977 144.69734,70.9436694 C147.91259,75.3134465 150.962016,79.8532119 153.837952,84.5259347 C159.03175,117.680556 155.071433,136.093913 144.962268,145.854571 C138.315284,142.501051 131.223373,139.526824 123.652837,136.776885 C106.05108,130.382625 89.8074316,126.151434 66.6081169,119.282455 C11.5200645,104.248308 -2.06515697,57.0116966 0.390998236,25.2467987 Z"
+              fill="url(#linearGradient-3)"></path>
+        <path d="M151.793359,81.2801612 C152.144238,81.8250562 152.490989,82.3658231 152.833612,82.9148461 L153.254668,83.5918367 C154.11329,84.970586 154.9554,86.3575913 155.785127,87.7611086 L155.925478,87.9964041 L156.14839,88.3761794 L156.350662,88.7270587 L156.945092,89.7466727 L156.986372,89.8209766 L157.791331,91.2327498 L157.816099,91.2740297 C158.398146,92.3018997 158.971937,93.3338977 159.537471,94.3741517 L159.607647,94.5062474 L160.235102,95.6703411 L160.251614,95.6992371 L160.940989,96.9954266 L161.139132,97.3752018 L161.523036,98.1141124 L161.993627,99.0263986 L162.447706,99.9097889 C162.910041,100.826203 163.368248,101.742617 163.818199,102.659031 L163.933783,102.886071 C164.746997,104.549652 165.535444,106.217361 166.307378,107.897453 L166.893553,109.181259 L166.951345,109.309227 L167.326992,110.143081 L167.764559,111.129671 L168.012239,111.699334 L168.408526,112.61162 L168.693358,113.267971 L169.291916,114.679744 L169.333196,114.778816 L169.973035,116.314429 L170.051467,116.500188 C170.732586,118.159641 171.393064,119.819094 172.032903,121.490931 L172.094823,121.643666 L172.623206,123.043056 L172.65623,123.121488 L172.961701,123.947086 C173.300197,124.8635 173.634564,125.779914 173.964803,126.700457 L174.092771,127.059592 C174.456034,128.087462 174.81517,129.11946 175.161921,130.14733 L175.273377,130.473441 C175.599488,131.439391 175.913215,132.405341 176.226943,133.371292 L176.379679,133.846011 L176.41683,133.957466 L176.912189,135.521975 L176.932829,135.592151 L177.391037,137.086484 L177.849244,138.626225 L177.861628,138.659249 L178.241403,139.959567 L178.361115,140.380622 L178.592282,141.18558 C178.852346,142.114378 179.108281,143.039049 179.355961,143.967847 L179.54172,144.661349 L179.900856,146.031843 L179.917368,146.097891 C180.354935,147.782111 180.767734,149.466332 181.159893,151.146425 L181.197045,151.3198 L181.238325,151.497304 C181.750196,153.714036 182.220787,155.922511 182.654226,158.122731 L182.695506,158.341515 C183.364241,161.76362 183.938032,165.165085 184.412751,168.537655 L184.421007,168.583063 C184.569615,169.623317 184.705838,170.659443 184.833806,171.695569 L184.88747,172.141392 L185.060846,173.623341 L185.060846,173.627469 L185.209453,174.997962 L185.258989,175.452041 L185.366317,176.537703 L185.407597,176.97527 L185.424109,177.152774 L185.556205,178.642979 C173.737764,163.423073 159.620031,152.933845 142.678752,144.727397 C156.350662,117.697306 154.431145,98.4360957 151.793359,81.2801612"
+              fill="url(#linearGradient-4)"></path>
+    </g>
+</svg>