From 2a04635f7a3ddf5e0f2c7e3def84416082ce3fe9 Mon Sep 17 00:00:00 2001
From: Webber <webber@takken.io>
Date: Wed, 29 Jan 2020 21:09:50 +0100
Subject: [PATCH] =?UTF-8?q?Update=20docs=20=E2=9C=A8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/workflows/main.yml |  3 +-
 README.md                  | 66 +++++++++++++++++++++++++++++---------
 2 files changed, 53 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 557ddf2..bd742af 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -22,12 +22,13 @@ jobs:
       - run: yarn build --quiet && git diff --quiet action || { echo "action should be auto generated" ; exit 62; }
 
   requestActivation:
-    name: Request activation ✔
+    name: Activate ${{ matrix.unityVersion }} ✔
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         unityVersion:
+          # Note: Major version differences may require different activation files.
           - 2018.4.15f1
           - 2019.2.11f1
           - 2019.2.14f1
diff --git a/README.md b/README.md
index 9469f2a..56391a5 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,33 @@
 # Unity - Activate
+
 [![Actions status](https://github.com/webbertakken/unity-activate/workflows/Actions%20%F0%9F%98%8E/badge.svg)](https://github.com/webbertakken/unity-activate/actions?query=branch%3Amaster+workflow%3A"Actions+😎")
 
 ---
 
-GitHub Action to [activate Unity](https://github.com/marketplace/actions/unity-activate). 
+GitHub Action to [activate Unity](https://github.com/marketplace/actions/unity-activate).
 
 Part of the [Unity Actions](https://github.com/webbertakken/unity-actions) collection.
 
 ---
 
-Use this action to activate Unity using credentials or a license file. Both 
+Use this action to activate Unity using credentials or a license file. Both
 **personal** and **professional** licenses are supported.
 
-Note that the latest versions of 
+Note that the latest versions of
 [Test](https://github.com/webbertakken/unity-actions#test) and
 [Build](https://github.com/webbertakken/unity-actions#build)
 contain standalone activation and no longer require this action.
 
 ### Documentation
 
-See the 
+See the
 [Unity Actions](https://github.com/webbertakken/unity-actions)
 collection repository for workflow documentation and reference implementation.
 
 ## Usage
 
 Create or edit the file called `.github/workflows/main.yml` and add a job to it.
- 
+
 ```yaml
 name: Activate Unity
 on: [push]
@@ -46,7 +47,7 @@ Continue to either the personal license or professional license section below.
 
 ```yaml
 - name: Activate Unity
-  uses: webbertakken/unity-activate@v1.1
+  uses: webbertakken/unity-activate@v1.2
   env:
     UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
 ```
@@ -55,30 +56,65 @@ Continue to either the personal license or professional license section below.
 
 1. Goto `Repository` > `Settings` > `Secrets`
 2. Set the following secrets:
-    - `UNITY_EMAIL`: &lt;your_unity_login_email_address&gt;
-    - `UNITY_PASSWORD`: &lt;your_unity_login_password&gt;
-    - `UNITY_SERIAL`: &lt;your_unity_serial&gt;
+   - `UNITY_EMAIL`: &lt;your_unity_login_email_address&gt;
+   - `UNITY_PASSWORD`: &lt;your_unity_login_password&gt;
+   - `UNITY_SERIAL`: &lt;your_unity_serial&gt;
 3. Use the action as follows:
 
 ```yaml
 - name: Activate Unity
-  uses: webbertakken/unity-activate@v1.1
+  uses: webbertakken/unity-activate@v1.2
   env:
-    UNITY_EMAIL:    ${{ secrets.UNITY_EMAIL }}
+    UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
     UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
-    UNITY_SERIAL:   ${{ secrets.UNITY_SERIAL }}
+    UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
 ```
 
+#### Specifying version
+
+Major version differences may require different activation files.
+
+To activate this job's environment for a specific version of unity
+
+```yaml
+- name: Activate Unity
+  uses: webbertakken/unity-activate@v1.2
+  env:
+    UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+  with:
+    unityVersion: 2019.2.11f1
+```
+
+#### Returning licenses
+
+When using Pro licenses, free spots are being used up by activating licenses.
+
+In order to keep continuity you need to return the license at the end of your workflow.
+
+Example:
+
+```yaml
+- name: Return license
+  uses: webbertakken/unity-return-license@v1
+  if: always()
+```
+
+For specific information about returning the license, visit
+the [return license](https://github.com/marketplace/actions/unity-return-license)
+docs.
+
+#### Save your workflow
+
 Commit and push your workflow definition.
 
 ## More actions
 
-Visit 
-[Unity Actions](https://github.com/webbertakken/unity-actions) 
+Visit
+[Unity Actions](https://github.com/webbertakken/unity-actions)
 to find related actions for Unity.
 
 Feel free to contribute.
 
-## Licence 
+## Licence
 
 [MIT](./LICENSE)