From 613050aa18ee18618f64981dd4ec53fb5a1e212c Mon Sep 17 00:00:00 2001 From: Shane Celis Date: Mon, 1 Mar 2021 04:42:07 -0500 Subject: [PATCH] doc: Add instructions for installing from NuGet. --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6423915..2e4ff64 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,22 @@ This is a Unity Package Template made according to Unity's [layout convention](h ## Installation -Install the template. +Install the template from NuGet or from a cloned repository. + +### Install from NuGet + +Install the template from NuGet. + + $ dotnet new --install SeawispHunter.Unity3D.Package.Template + +### Install from repository + +Install the template from git repo. $ git clone https://github.com/shanecelis/unity-package-template $ dotnet new --install unity-package-template + ## Usage Create a directory. Choose the name carefully; its name is your package's name. @@ -16,7 +27,7 @@ Create a directory. Choose the name carefully; its name is your package's name. $ mkdir MyPackage $ cd MyPackage $ dotnet new unitypackage --company "My Company" - + This creates the following files (meta files excluded for clarity): MyPackage @@ -39,11 +50,11 @@ This creates the following files (meta files excluded for clarity): │   ├── MyCompany.MyPackage.Tests.asmdef │   └── RuntimeExampleTest.cs └── package.json - + The generated package name is "com.mycompany.mypackage" but edit that to your liking. Many values are only located within the `package.json` file, like the package description. It's expected that you will edit it after generation. - + $ $EDITOR package.json - + ## Using the Package See Unity's documentation for ways that you can [share your package](https://docs.unity3d.com/Manual/cus-share.html).