Readme file updated

Author: paramtamtam

README.md

@@ -1,3 +1,4 @@
+
 <p align="center">
   <img src="https://laravel.com/assets/img/components/logo-laravel.svg" alt="Laravel" width="240" />
 </p>
@@ -13,7 +14,7 @@
 [![License][badge_license]][link_license]
 [![Downloads count][badge_downloads_count]][link_packagist]
 
-{% Более полное описание пакета, которое позволяет принять решение о его предназначении и применимости в том проекте, работа над которым привела пользователя в данный репозиторий. %}
+По умолчанию Laravel не имеет встроенного механизма для работы со значением версии приложения, и данный пакет предназначен восполнить данный недостаток. Используя его вы сможете в произвольном месте вашего кода получать значение версии приложения, хранить его в отдельном файле (для реализации возможности его чтения, например - другими приложениями), и обновлять версию сборки при необходимости прямо во время работы приложения, или консоли.
 
 ## Установка
 
@@ -27,18 +28,69 @@ $ composer require avto-dev/app-version-laravel "^1.0"
 
 > Обратите внимание на то, что необходимо фиксировать мажорную версию устанавливаемого пакета.
 
-Если вы используете Laravel версии 5.5 и выше, то сервис-провайдер данного пакета будет зарегистрирован автоматически. В противном случае вам необходимо самостоятельно зарегистрировать сервис-провайдер в секции `providers` файла `./config/app.php`:
+> Если вы используете Laravel версии 5.5 и выше, то сервис-провайдер данного пакета будет зарегистрирован автоматически. В противном случае вам необходимо самостоятельно зарегистрировать сервис-провайдер в секции `providers` файла `./config/app.php`:
+> 
+> ```php
+> 'providers' => [
+>     // ...
+>     AvtoDev\AppVersion\AppVersionServiceProvider::class,
+> ]
+> ```
 
-```php
-'providers' => [
-    // ...
-    AvtoDev\AppVersion\AppVersionServiceProvider::class,
+После этого "опубликуйте" конфигурационный файл:
+
+```shell
+$ php artisan vendor:publish --provider="AvtoDev\\AppVersion\\AppVersionServiceProvider"
+```
+
+И произведите необходимые настройки в файле `./config/version.php`. Каждое значение в конфигурационном файле имеет подробное описание.
+
+Для того, чтоб файл со значением версии обновлялся автоматически, добавьте следующую строку в секцию `post-autoload-dump` файла `composer.json` вашего приложения:
+
+```json
+"post-autoload-dump": [
+    "@php artisan version --refresh"
 ]
 ```
 
 ## Использование
 
-{% В данном блоке следует максимально подробно рассказать о том, какие задачи решает данный пакет, какое API предоставляет разработчику, из каких компонентов состоит и привести примеры использования с примерами кода. Привести максимально подробне разъяснения и комментарии. %}
+В целях оптимизации и возможности доступа ко значению версии другими приложениями данные версии и сборки (билда) приложения по умолчанию хранятся в файлах `./storage/app/APP_VERSION` и `./storage/app/APP_BUILD` соответственно (находятся **не** под гитом).
+
+> Помните, что при ручном обновлении конфигурационного файла с версией вам будет выполнить команду `php artisan version --refresh`.
+
+Пути к файлам вы, разумеется, можете переопределить на произвольные. Так же вы можете установить произвольный формат вывода версии (`1.0.0-beta` или `ver. 1.0.0 (build beta)`) - как только пожелаете.
+
+### Artisan-команды
+
+При использовании данного пакета вам доступны следующие artisan-команды и их аргументы:
+
+Сигнатура команды | Описание
+----------------- | --------
+`version` | Выводит значение версии приложения
+`version --build` | Выводит только значение сборки приложения
+`version --set-build=alpha2` | Устанавливает значение сборки приложения равное `alpha2`
+`version --refresh` | Обновляет (пересоздаёт) файлы со значениями версий
+
+### Blade
+
+В ваших blade-шаблонах вы можете использовать следующие конструкции:
+
+```smarty
+Application version: @app_version
+Build version: @app_build
+```
+
+### Хэлперы
+
+Так же вам доступны следующие хэлперы:
+
+```php
+<?php
+
+app_version(); // 1.0.0-alpha2
+app_build(); // alpha2
+```
 
 ### Тестирование
 

tests/stubs/view/app_build.blade.php

@@ -1 +1 @@
-Build version: @app_build()
+Build version: @app_build

tests/stubs/view/app_version.blade.php

@@ -1 +1 @@
-Application version: @app_version()
+Application version: @app_version