Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: installation option and the OpenUPM badge #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Compute Stochastic Screen Space Reflections

[![openupm](https://img.shields.io/npm/v/com.simeonradivoev.stochastic-reflections?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.simeonradivoev.stochastic-reflections/)

Compute Stochastic Screen Space Reflections for Unity post processing. Utilizing shared memory for performance.
Should be mostly production ready, except for a few Hierarchical Z-depth casting artifacts.

Expand Down Expand Up @@ -31,6 +34,16 @@ Should be mostly production ready, except for a few Hierarchical Z-depth casting
* Tested with Unity 2018.2

# Installation

## Install via OpenUPM

The package is available on the [openupm registry](https://openupm.com). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).

```
openupm add com.simeonradivoev.stochastic-reflections
```

## Install via Git URL
In a unity project go to your `Packages` folder. Open `manifest.json` and add into the dependencies the following line:

```
Expand Down