Merge pull request #6 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/).
 
+## [3.2.1] - 2022-10-24
+- Added: OpenUPM documentation.
+
 ## [3.2.0] - 2022-10-03
 - Fixed: Updated assembly definition and namespaces names to reflect the organization name changes.
 
@@ -53,6 +56,7 @@ All notable changes to this project will be documented in this file. This projec
 ## [1.0.0] - 2019-07-27
 - Initial Asset Store release.
 
+[3.2.1]: https://github.com/mygamedevtools/script-template/compare/3.2.0...3.2.1
 [3.2.0]: https://github.com/mygamedevtools/script-template/compare/3.1.0...3.2.0
 [3.1.0]: https://github.com/mygamedevtools/script-template/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/mygamedevtools/script-template/compare/2.2.0...3.0.0

README.md

@@ -1,4 +1,5 @@
 ![License](https://img.shields.io/github/license/mygamedevtools/script-template)
+[![openupm](https://img.shields.io/npm/v/com.mygamedevtools.script-template?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.mygamedevtools.script-template/)
 ![Release](https://img.shields.io/github/v/release/mygamedevtools/script-template?sort=semver)
 ![Last Commit](https://img.shields.io/github/last-commit/mygamedevtools/script-template)
 
@@ -15,10 +16,21 @@ This tool adds custom Script Templates to Unity that will serve as alternatives
 Installation
 ---
 
-#### [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/script-template.git` and click `Add`. The package will be imported by the Package Manager.
+### OpenUPM
 
-:link: [Unity Official Documentation](https://docs.unity3d.com/Manual/upm-git.html)
+This package is available on the [OpenUPM](https://openupm.com/packages/com.mygamedevtools.script-template) registry. Add the package via the [openupm-cli](https://github.com/openupm/openupm-cli):
+
+```
+openupm add com.mygamedevtools.script-template
+```
+
+### [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.script-template` into name.
+5. Click `Add`.
 
 Usage
 ---

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.mygamedevtools.script-template",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "displayName": "Script Templates",
   "description": "This tool adds custom Script Templates to Unity that will serve as alternatives for the default \"C#Script\" that I personally always modify before writing my scripts.\nIn essence, it allows customization of the script templates with dynamic data such as signature and namespace settings.\nAdditionally, it adds templates for others types of scripts rather than just Mono Behaviours.",
   "unity": "2019.4",
@@ -13,7 +13,7 @@
     "editor"
   ],
   "author": {
-    "name": "My Unity Tools",
+    "name": "My GameDev Tools",
     "email": "[email protected]",
     "url": "https://github.com/mygamedevtools"
   },