Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stan-osipov authored Oct 11, 2020
1 parent ef60bcf commit 2ecef17
Showing 1 changed file with 1 addition and 55 deletions.
56 changes: 1 addition & 55 deletions com.stansassets.plugins-dev-kit/README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,6 @@
# Package Sample
<!-- Describe your package -->
# Internal Plugins dev kit

[![NPM Package](https://img.shields.io/npm/v/com.stansassets.plugins-dev-kit)](https://www.npmjs.com/package/com.stansassets.plugins-dev-kit)
[![openupm](https://img.shields.io/npm/v/com.stansassets.plugins-dev-kit?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.stansassets.plugins-dev-kit/)
[![Licence](https://img.shields.io/npm/l/com.stansassets.plugins-dev-kit)](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/blob/master/LICENSE)
[![Issues](https://img.shields.io/github/issues/StansAssets/com.stansassets.plugins-dev-kit)](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/issues)

<!-- Add some useful links here -->

[API Reference](https://myapi) | [Forum](https://myforum) | [Wiki](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/wiki)

### Install from NPM
* Navigate to the `Packages` directory of your project.
* Adjust the [project manifest file](https://docs.unity3d.com/Manual/upm-manifestPrj.html) `manifest.json` in a text editor.
* Ensure `https://registry.npmjs.org/` is part of `scopedRegistries`.
* Ensure `com.stansassets` is part of `scopes`.
* Add `com.stansassets.plugins-dev-kit` to the `dependencies`, stating the latest version.

A minimal example ends up looking like this. Please note that the version `X.Y.Z` stated here is to be replaced with [the latest released version](https://www.npmjs.com/package/com.stansassets.foundation) which is currently [![NPM Package](https://img.shields.io/npm/v/com.stansassets.foundation)](https://www.npmjs.com/package/com.stansassets.foundation).
```json
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"com.stansassets"
]
}
],
"dependencies": {
"com.stansassets.plugins-dev-kit": "X.Y.Z",
...
}
}
```
* Switch back to the Unity software and wait for it to finish importing the added package.

### Install from OpenUPM
* Install openupm-cli `npm install -g openupm-cli` or `yarn global add openupm-cli`
* Enter your unity project folder `cd <YOUR_UNITY_PROJECT_FOLDER>`
* Install package `openupm add com.stansassets.plugins-dev-kit`

### Install from a Git URL
Yoy can also install this package via Git URL. To load a package from a Git URL:

* Open [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window.
* Click the add **+** button in the status bar.
* The options for adding packages appear.
* Select Add package from git URL from the add menu. A text box and an Add button appear.
* Enter the `https://github.com/StansAssets/com.stansassets.plugins-dev-kit.git` Git URL in the text box and click Add.
* You may also install a specific package version by using the URL with the specified version.
* `https://github.com/StansAssets/com.stansassets.plugins-dev-kit#X.Y.X`
* Please note that the version `X.Y.Z` stated here is to be replaced with the version you would like to get.
* You can find all the available releases [here](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/releases).
* The latest available release version is [![Last Release](https://img.shields.io/github/v/release/stansassets/com.stansassets.plugins-dev-kit)](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/releases/latest)

For more information about what protocols Unity supports, see [Git URLs](https://docs.unity3d.com/Manual/upm-git.html).

0 comments on commit 2ecef17

Please sign in to comment.