Merge pull request #5 from mygamedevtools/update/open-upm-docs

[Update] Add OpenUPM documentation

Author: joaoborks

CHANGELOG.md

@@ -3,6 +3,9 @@ Change Log
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.3.1] - 2022-10-24
+- Added: OpenUPM documentation.
+
 ## [1.3.0] - 2022-10-03
 - Fixed: Updated assembly definition and namespaces names to reflect the organization name changes.
 
@@ -16,6 +19,8 @@ All notable changes to this project will be documented in this file. This projec
 ## [1.0.0] - 2022-09-05
 - Initial Release.
 
+[1.3.1]: https://github.com/mygamedevtools/scene-loader/compare/1.3.0...1.3.1
+[1.3.0]: https://github.com/mygamedevtools/scene-loader/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/mygamedevtools/scene-loader/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/mygamedevtools/scene-loader/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/mygamedevtools/scene-loader/compare/f2b6582...1.0.0

README.md

@@ -1,4 +1,5 @@
 ![License](https://img.shields.io/github/license/mygamedevtools/scene-loader)
+[![openupm](https://img.shields.io/npm/v/com.mygamedevtools.scene-loader?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.mygamedevtools.scene-loader/)
 ![Release](https://img.shields.io/github/v/release/mygamedevtools/scene-loader?sort=semver)
 ![Last Commit](https://img.shields.io/github/last-commit/mygamedevtools/scene-loader)
 
@@ -10,21 +11,22 @@ _A package that standardizes the scene loading process among many different poss
 Installation
 ---
 
-#### - For 2019.1+: [Installing from a git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html) _(requires [Git](https://git-scm.com/) installed and added to the PATH)_
-You can open the Package Manager and then click on the `+` button on the top left corner. 
-From there select `Add package from git URL...`, type `https://github.com/mygamedevtools/scene-loader.git` and click `Add`. 
-The package will be imported by the Package Manager.
+### OpenUPM
+
+This package is available on the [OpenUPM](https://openupm.com/packages/com.mygamedevtools.scene-loader) registry. Add the package via the [openupm-cli](https://github.com/openupm/openupm-cli):
 
-#### - Other Package Manager supported versions: Add manually to manifest
-You should add this to your `manifest.json` under the `Packages` folder on the root of your Unity Project:
 ```
-{
-  "dependencies": {
-	  "com.mygamedevtools.scene-loader": "https://github.com/mygamedevtools/scene-loader.git"
-  }
-}
+openupm add com.mygamedevtools.scene-loader
 ```
 
+### [Installing from Git](https://docs.unity3d.com/Manual/upm-ui-giturl.html) _(requires [Git](https://git-scm.com/) installed and added to the PATH)_
+
+1. Open `Edit/Project Settings/Package Manager`.
+2. Click <kbd>+</kbd>.
+3. Select `Add package from git URL...`.
+4. Paste `com.mygamedevtools.scene-loader` into name.
+5. Click `Add`.
+
 Overview
 ---
 

package.json

@@ -1,12 +1,12 @@
 {
   "name": "com.mygamedevtools.scene-loader",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "displayName": "Scene Loader",
   "description": "A package that standardizes the scene loading process among many different possibilities, including support for Coroutines, C# Tasks, UniTask and Addressables.",
   "unity": "2019.4",
   "keywords": [],
   "author": {
-    "name": "My Unity Tools",
+    "name": "My GameDev Tools",
     "email": "joao.borks@gmail.com.br",
     "url": "https://github.com/mygamedevtools"
   },