From eb4623a93947d971ab7e8c3881fe336d4b8b20a8 Mon Sep 17 00:00:00 2001 From: Favo Yang Date: Sun, 31 May 2020 23:48:48 +0800 Subject: [PATCH] docs: add installation option via OpenUPM (#268) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 9907392..0207ad3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![GitHub issues](https://img.shields.io/github/issues/Siccity/xNode.svg)](https://github.com/Siccity/xNode/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/Siccity/xNode/master/LICENSE.md) [![GitHub Wiki](https://img.shields.io/badge/wiki-available-brightgreen.svg)](https://github.com/Siccity/xNode/wiki) +[![openupm](https://img.shields.io/npm/v/com.github.siccity.xnode?label=openupm®istry_uri=https://package.openupm.com)](https://openupm.com/packages/com.github.siccity.xnode/) [Downloads](https://github.com/Siccity/xNode/releases) / [Asset Store](http://u3d.as/108S) / [Documentation](https://github.com/Siccity/xNode/wiki) @@ -33,6 +34,7 @@ With a minimal footprint, it is ideal as a base for custom state machines, dialo * [Examples branch](https://github.com/Siccity/xNode/tree/examples) - look at other small projects ### Installing with Unity Package Manager +***Via Git URL*** *(Requires Unity version 2018.3.0b7 or above)* To install this project as a [Git dependency](https://docs.unity3d.com/Manual/upm-git.html) using the Unity Package Manager, @@ -46,6 +48,14 @@ You will need to have Git installed and available in your system's PATH. If you are using [Assembly Definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) in your project, you will need to add `XNode` and/or `XNodeEditor` as Assembly Definition References. +***Via OpenUPM*** + +The package is available on the [openupm registry](https://openupm.com). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli). + +``` +openupm add com.github.siccity.xnode +``` + ### Node example: ```csharp // public classes deriving from Node are registered as nodes for use within a graph