Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update registry location
  • Loading branch information
Voltstro committed Aug 11, 2022
1 parent a876723 commit 486ab63
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
registry=https://pkgs.dev.azure.com/Voltstro-Studios/UnityPackages/_packaging/UPM/npm/registry/
registry=https://upm-pkgs.voltstro.dev
always-auth=true
Binary file removed Media~/PackageManager.png
Binary file not shown.
32 changes: 11 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,25 @@ Voltstro-Studios' Unity build tool, with a modular scripting design.

## Installation

### Voltstro-Studios UPM
There are three main sources on how you can install this package. Pick which ever one suites you the best!

You can install this package from our Azure UPM. Using a scoped registry will make updating a lot easier.
### Voltstro UPM

To add the registry, simply goto Edit **->** Project Settings **->** Package Manager, and add it to 'Scoped Registries' like so:
You can install this package from our custom UPM registry. To setup our registry, see [here](https://github.com/Voltstro/VoltstroUPM#setup).

![Registry](https://user-images.githubusercontent.com/45032877/148951575-e962ed43-70bd-4eff-a8ce-5888cf0a9318.png)
Once you have the registry added to your project, you can install it like any other package via the package manager.

Or add it via your project's `manifest.json` file:
### OpenUPM

```json
{
"scopedRegistries": [
{
"name": "Voltstro-Studios UPM",
"url": "https://pkgs.dev.azure.com/Voltstro-Studios/UnityPackages/_packaging/UPM/npm/registry",
"scopes": [
"dev.voltstro"
]
}
]
}
```
You can install this package via [OpenUPM](https://openupm.com/).

It will then appear in your package manage under 'My Registries', you can install it like any other Unity package.
To install it, use their CLI:

![UPM](Media~/PackageManager.png)
```bash
openupm-cli add dev.voltstro.unityvoltbuilder
```

## Git
### Git

To install it via the package manager with git you will need to:

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "dev.voltstro.unityvoltbuilder",
"displayName": "Unity Volt Builder",
"version": "4.1.1",
"version": "4.1.2",
"unity": "2020.3",
"description": "Voltstro-Studios' Unity build tool, with a modular scripting design.",
"author": {
Expand Down

0 comments on commit 486ab63

Please sign in to comment.