Skip to content

Commit 0540225

Browse files
committed
Update to README files
1 parent 099ec21 commit 0540225

File tree

3 files changed

+28
-6
lines changed

3 files changed

+28
-6
lines changed

Packages/webxr-interactions/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ This package adds Interaction Components and Samples for the WebXR Export packag
44

55
You can [check the live demo here](https://de-panther.github.io/unity-webxr-export)
66

7-
To add the package to your Unity project, open the Package Manager window, click on the + icon, "Add package from git URL..." and add the path URL
7+
## Downloads
8+
9+
There are two options to import the package to a Unity project.
10+
11+
* Use OpenUPM [WebXR Interactions ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/). It's the best option, as it is much more easier to update the package later.
12+
13+
* Use Git. It can let you use versions that are yet uploaded to OpenUPM - Mostly happens between releases.
14+
15+
### Using Git
16+
17+
To add the package to your Unity project using Git, open the Package Manager window, click on the + icon, "Add package from git URL..." and add the path URL
818

919
`https://github.com/De-Panther/unity-webxr-export.git?path=/Packages/webxr-interactions`
1020

Packages/webxr/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,25 @@
22

33
You can [check the live demo here](https://de-panther.github.io/unity-webxr-export)
44

5-
To add the package to your Unity project, open the Package Manager window, click on the + icon, "Add package from git URL..." and add the path URL
5+
## Downloads
6+
7+
There are two options to import the package to a Unity project.
8+
9+
* Use OpenUPM [WebXR Export ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr/). It's the best option, as it is much more easier to update the package later.
10+
11+
* Use Git. It can let you use versions that are yet uploaded to OpenUPM - Mostly happens between releases.
12+
13+
### Using Git
14+
15+
To add the package to your Unity project using Git, open the Package Manager window, click on the + icon, "Add package from git URL..." and add the path URL
616

717
`https://github.com/De-Panther/unity-webxr-export.git?path=/Packages/webxr`
818

919
Then make sure to check `WebXR Export` in `Project Settings > XR Plug-in Management > WebGL > Plug-in Providers`.
1020

1121
To update the package, you'll have to manually remove the corresponding package section from the `packages-lock.json` file. For more info read about [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html) in Unity's manual.
1222

23+
## WebXR Interactions
1324

1425
You might also want to add the WebXR Interactions package, as it has some Interaction Components and Samples.
15-
You can get the WebXR Interactions package [here](../webxr-interactions/README.md)
26+
You can get the WebXR Interactions package [here](../webxr-interactions/README.md) or at OpenUPM [WebXR Interactions ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/).

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ I deleted all the docs, as they are no longer relevant.
1717
## Downloads
1818

1919
Better option: Import WebXR Export and WebXR Interactions packages from OpenUPM.
20-
- WebXR Export [![openupm](https://img.shields.io/npm/v/com.de-panther.webxr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr/)
21-
- WebXR Interactions [![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/)
20+
- [WebXR Export ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr/)
21+
- [WebXR Interactions ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/)
2222

2323
Or import the packages from git, more info at [WebXR Export](Packages/webxr/README.md) and [WebXR Interactions](Packages/webxr-interactions/README.md).
2424

@@ -32,7 +32,8 @@ Or just use this as a Unity Package (UPM), more info [here](Packages/webxr/READM
3232

3333
### Unity editor version
3434

35-
* `2019.4.7` and above. (No support for `2020.x` yet)
35+
* `2019.4.7` and up.
36+
* `2020.1` and up.
3637

3738
### Browser Compatibility
3839

0 commit comments

Comments
 (0)