Skip to content

Commit

Permalink
Chore: Update README, move installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
bigtimebuddy committed Jan 21, 2024
1 parent 7802ef3 commit 867dd22
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,22 @@ Depending on your version of PixiJS, you'll need to figure out which major versi
| v6.x - v7.x | v5.x |
| v8.x | v6.x |

## Installation

Installation is available using NPM:

```bash
npm install pixi-filters
```

Alternatively, you can use a CDN such as JSDelivr:

```html
<script src="https://cdn.jsdelivr.net/npm/pixi-filters@latest/dist/browser/pixi-filters.min.js"></script>
```

If all else failes, you can manually download the bundled file from the [releases](https://github.com/pixijs/filters/releases) section and include it in your project.

## Demo

[View the PixiJS Filters Demo](https://pixijs.io/filters/examples/) to interactively play with filters to see how they work.
Expand Down Expand Up @@ -76,22 +92,6 @@ PixiJS has a handful of core filters that are built-in to the PixiJS library.
| **DisplacementFilter**<br>[View demo][Displacement_demo] | ![displacement](https://filters.pixijs.download/main/screenshots/displacement.png?v=3) |
| **NoiseFilter**<br>[View demo][Noise_demo] | ![noise](https://filters.pixijs.download/main/screenshots/noise.png?v=3) |

## Installation

Installation is available using NPM:

```bash
npm install pixi-filters
```

Alternatively, you can use a CDN such as JSDelivr:

```html
<script src="https://cdn.jsdelivr.net/npm/pixi-filters@latest/dist/browser/pixi-filters.min.js"></script>
```

If all else failes, you can manually download the bundled file from the [releases](https://github.com/pixijs/filters/releases) section and include it in your project.

## Building

PixiJS Filters uses [Lerna](https://github.com/lerna/lerna) under-the-hood to build all of the filters separately. Install all dependencies by simply running the following.
Expand Down

0 comments on commit 867dd22

Please sign in to comment.