From c94f04b75a6af993e4044755cf3310125573730c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Borks?= Date: Mon, 24 Oct 2022 19:19:33 -0300 Subject: [PATCH 1/3] Add OpenUPM documentation --- CHANGELOG.md | 3 +++ README.md | 35 ++++++++++++++++++++++++----------- package.json | 2 +- 3 files changed, 28 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6ee9eb..e769e88 100644 --- a/CHANGELOG.md +++ b/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 - Changed: Updated organization name to comply with [Unity Package Guidelines](https://unity.com/legal/terms-of-service/software/package-guidelines). - Fixed: Updated assembly definition and namespaces names to reflect the organization name changes. diff --git a/README.md b/README.md index 5274c01..4a9b7fe 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ![License](https://img.shields.io/github/license/mygamedevtools/extensions) +[![openupm](https://img.shields.io/npm/v/com.mygamedevtools.extensions?label=openupm®istry_uri=https://package.openupm.com)](https://openupm.com/packages/com.mygamedevtools.extensions/) ![Release](https://img.shields.io/github/v/release/mygamedevtools/extensions?sort=semver) ![Last Commit](https://img.shields.io/github/last-commit/mygamedevtools/extensions) @@ -10,21 +11,33 @@ _A personal collection of Unity Engine tools, extensions, and helpers._ 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/extensions.git` and click `Add`. -The package will be imported by the Package Manager. +### 1. OpenUPM + +This package is available on the [OpenUPM](https://openupm.com/packages/com.mygamedevtools.extensions) 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.extensios": "https://github.com/mygamedevtools/extensions.git" - } -} +openupm add com.mygamedevtools.extensions ``` +Or, manually: + +1. Open `Edit/Project Settings/Package Manager`. +2. Add a new **Scoped Registry** (or edit the existing OpenUPM entry): + * Name `OpenUPM` + * URL `https://package.openupm.com` + * Scope(s) `com.mygamedevtools` +6. Click `Save` (or `Apply`). +7. Open `Window/Package Manager`. +8. Click +. +9. Select `Add package by name...` or `Add package from git URL...`. +10. Paste `com.mygamedevtools.extensions` into name. +12. Click `Add`. + +### 2. [Unity Package Manager](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/extensions.git` and click `Add`. + Usage --- diff --git a/package.json b/package.json index d4d802d..19596da 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "com.mygamedevtools.extensions", - "version": "1.3.0", + "version": "1.3.1", "displayName": "Extensions", "description": "A personal collection of Unity Engine tools, extensions and helpers.", "unity": "2019.4", From 108f2d9f7ef902aa6bc15228aaedb05d85658169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Borks?= Date: Mon, 24 Oct 2022 19:23:15 -0300 Subject: [PATCH 2/3] Simplify readme instructions --- README.md | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4a9b7fe..65e998d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ _A personal collection of Unity Engine tools, extensions, and helpers._ Installation --- -### 1. OpenUPM +### OpenUPM This package is available on the [OpenUPM](https://openupm.com/packages/com.mygamedevtools.extensions) registry. Add the package via the [openupm-cli](https://github.com/openupm/openupm-cli): @@ -19,24 +19,13 @@ This package is available on the [OpenUPM](https://openupm.com/packages/com.myga openupm add com.mygamedevtools.extensions ``` -Or, manually: +### [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. Add a new **Scoped Registry** (or edit the existing OpenUPM entry): - * Name `OpenUPM` - * URL `https://package.openupm.com` - * Scope(s) `com.mygamedevtools` -6. Click `Save` (or `Apply`). -7. Open `Window/Package Manager`. -8. Click +. -9. Select `Add package by name...` or `Add package from git URL...`. -10. Paste `com.mygamedevtools.extensions` into name. -12. Click `Add`. - -### 2. [Unity Package Manager](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/extensions.git` and click `Add`. +2. Click +. +3. Select `Add package from git URL...`. +4. Paste `com.mygamedevtools.extensions` into name. +5. Click `Add`. Usage --- From c03b45ebc8d0c7c9dcb9501cad9bf505ea0ff665 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Borks?= Date: Mon, 24 Oct 2022 19:29:20 -0300 Subject: [PATCH 3/3] Fix changelog link --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e769e88..7847970 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,7 @@ All notable changes to this project will be documented in this file. This projec - Added: `DebugExtensions` to help debugging arrays and collections. - Added: `GameObjectExtensions` to help with common `GameObject` operations. +[1.3.1]: https://github.com/joaoborks/mygamedevtools-extensions/compare/1.3.0...1.3.1 [1.3.0]: https://github.com/joaoborks/mygamedevtools-extensions/compare/1.2.0...1.3.0 [1.2.0]: https://github.com/joaoborks/mygamedevtools-extensions/compare/1.1.0...1.2.0 [1.1.0]: https://github.com/joaoborks/mygamedevtools-extensions/compare/1.0.0...1.1.0