Skip to content

Commit 2ecef17

Browse files
authored
Update README.md
1 parent ef60bcf commit 2ecef17

File tree

1 file changed

+1
-55
lines changed

1 file changed

+1
-55
lines changed
Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,6 @@
1-
# Package Sample
2-
<!-- Describe your package -->
1+
# Internal Plugins dev kit
32

43
[![NPM Package](https://img.shields.io/npm/v/com.stansassets.plugins-dev-kit)](https://www.npmjs.com/package/com.stansassets.plugins-dev-kit)
54
[![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/)
65
[![Licence](https://img.shields.io/npm/l/com.stansassets.plugins-dev-kit)](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/blob/master/LICENSE)
76
[![Issues](https://img.shields.io/github/issues/StansAssets/com.stansassets.plugins-dev-kit)](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/issues)
8-
9-
<!-- Add some useful links here -->
10-
11-
[API Reference](https://myapi) | [Forum](https://myforum) | [Wiki](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/wiki)
12-
13-
### Install from NPM
14-
* Navigate to the `Packages` directory of your project.
15-
* Adjust the [project manifest file](https://docs.unity3d.com/Manual/upm-manifestPrj.html) `manifest.json` in a text editor.
16-
* Ensure `https://registry.npmjs.org/` is part of `scopedRegistries`.
17-
* Ensure `com.stansassets` is part of `scopes`.
18-
* Add `com.stansassets.plugins-dev-kit` to the `dependencies`, stating the latest version.
19-
20-
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).
21-
```json
22-
{
23-
"scopedRegistries": [
24-
{
25-
"name": "npmjs",
26-
"url": "https://registry.npmjs.org/",
27-
"scopes": [
28-
"com.stansassets"
29-
]
30-
}
31-
],
32-
"dependencies": {
33-
"com.stansassets.plugins-dev-kit": "X.Y.Z",
34-
...
35-
}
36-
}
37-
```
38-
* Switch back to the Unity software and wait for it to finish importing the added package.
39-
40-
### Install from OpenUPM
41-
* Install openupm-cli `npm install -g openupm-cli` or `yarn global add openupm-cli`
42-
* Enter your unity project folder `cd <YOUR_UNITY_PROJECT_FOLDER>`
43-
* Install package `openupm add com.stansassets.plugins-dev-kit`
44-
45-
### Install from a Git URL
46-
Yoy can also install this package via Git URL. To load a package from a Git URL:
47-
48-
* Open [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window.
49-
* Click the add **+** button in the status bar.
50-
* The options for adding packages appear.
51-
* Select Add package from git URL from the add menu. A text box and an Add button appear.
52-
* Enter the `https://github.com/StansAssets/com.stansassets.plugins-dev-kit.git` Git URL in the text box and click Add.
53-
* You may also install a specific package version by using the URL with the specified version.
54-
* `https://github.com/StansAssets/com.stansassets.plugins-dev-kit#X.Y.X`
55-
* Please note that the version `X.Y.Z` stated here is to be replaced with the version you would like to get.
56-
* You can find all the available releases [here](https://github.com/StansAssets/com.stansassets.plugins-dev-kit/releases).
57-
* 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)
58-
59-
For more information about what protocols Unity supports, see [Git URLs](https://docs.unity3d.com/Manual/upm-git.html).
60-

0 commit comments

Comments
 (0)