From 1db397c0a1c8e4149322b5d2f5dab54509b271be Mon Sep 17 00:00:00 2001
From: Tymko Oleg <olegtymko@yandex.ru>
Date: Tue, 14 Apr 2020 19:51:01 +0700
Subject: [PATCH] =?UTF-8?q?=D0=9D=D0=B0=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=20re?=
 =?UTF-8?q?adme=20=D0=B8=20=D0=B4=D0=BE=D0=BF=D0=BE=D0=BB=D0=BD=D0=B5?=
 =?UTF-8?q?=D0=BD=20action.yml.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md  | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 action.yml |  2 +-
 2 files changed, 59 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 214a7f3..30e74bb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,58 @@
-# setup-oscript
\ No newline at end of file
+# Setup-Onescript
+
+Setup-Onescript позволяет использовать в действия Github Action [Onescript](https://oscript.io/). При установке используется другой проект [OVM](https://github.com/oscript-library/ovm) - OneScript Version Manager.
+
+## Использование
+
+Описание действия [action.yml](action.yml)
+
+### Базовый пример
+
+```yaml
+- uses: actions/checkout@v2
+- uses: otymko/setup-onescript@v1
+  with:
+    version: 1.3.0 # Требуемая версия OneScript
+- run: oscript /path/to/script/test.os
+```
+
+Параметр `version` поддерживает следующие значения:
+* 1.0.21
+* 1.2.0
+* 1.3.0
+* dev (текущая ночная сборка)
+
+### Использование matrix
+
+```yaml
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        oscript_version: [1.2.0, 1.3.0, dev]
+    name: Тестирование проекта
+    steps:
+      - uses: actions/checkout@v2
+      - name: Установка Onescript
+        uses: otymko/setup-onescript@v1
+        with:
+          java-version: ${{ matrix.oscript_version }}
+      - run: oscript /path/to/script/test.os
+
+```
+
+### Пример использования
+
+Этот Action используется в проекте [GitRules](https://github.com/otymko/gitrules). В этом проекте реализован workflow для тестирования.
+
+# Лицензия
+
+Данный проект размещен под лицензией [MIT License](LICENSE)
+
+# Контрибьютерам
+
+Доработка проводится по git-flow.
+
+
+
diff --git a/action.yml b/action.yml
index 9482f81..f8ccb93 100644
--- a/action.yml
+++ b/action.yml
@@ -3,7 +3,7 @@ description: 'Setup your runner with Onescript'
 author: 'otymko'
 inputs: 
   version:
-    description: 'Version of Onescript to use'
+    description: 'Version of Onescript to use. Support value: 1.0.21, 1.2.0, 1.3.0, dev'
 runs:
   using: 'node12'
   main: 'dist/index.js'
\ No newline at end of file