Skip to content

Commit 4a13213

Browse files
committed
docs: refresh README demo links, drop stale semantic-release docs
README's Bubbles/Take Control demos now point to pmndrs.github.io/examples instead of dead CodeSandbox links, Storybook badge relabeled to Docs (it never used Storybook), and an unnecessary React import removed from the example. CONTRIBUTING's Publishing section described semantic-release, which this repo doesn't use (releases are manual via workflow_dispatch).
1 parent 0730e6a commit 4a13213

2 files changed

Lines changed: 6 additions & 17 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,3 @@ You can also just [![Open in GitHub Codespaces](https://img.shields.io/static/v1
1414
## Commit Guidelines
1515

1616
Be sure your commit messages follow this specification: https://www.conventionalcommits.org/en/v1.0.0-beta.4/
17-
18-
## Publishing
19-
20-
We use `semantic-release` to deploy the package. Because of this only certain commits will trigger the action of creating a release:
21-
22-
- `fix:` will create a `0.0.x` version
23-
- `feat:` will create a `0.x.0` version
24-
- `BREAKING CHANGE:` will create a `x.0.0` version
25-
26-
We release on `master` branch. Any other commits will not fire a release.

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# react-postprocessing
22

33
[![Version](https://img.shields.io/npm/v/@react-three/postprocessing?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@react-three/postprocessing)
4-
[![Storybook](https://img.shields.io/static/v1?message=Storybook&style=flat&colorA=000000&colorB=000000&label=&logo=storybook&logoColor=ffffff)](https://pmndrs.github.io/react-postprocessing)
4+
[![Docs](https://img.shields.io/static/v1?message=Docs&style=flat&colorA=000000&colorB=000000&label=&logo=googledocs&logoColor=ffffff)](https://pmndrs.github.io/react-postprocessing)
55
[![Downloads](https://img.shields.io/npm/dt/@react-three/postprocessing.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@react-three/postprocessing)
66
[![Discord Shield](https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/ZZjjNvJ)
77
[![Open in GitHub Codespaces](https://img.shields.io/static/v1?&message=Open%20in%20%20Codespaces&style=flat&colorA=000000&colorB=000000&label=GitHub&logo=github&logoColor=ffffff)](https://github.com/codespaces/new?template_repository=pmndrs%2Freact-postprocessing)
@@ -18,8 +18,8 @@ npm install @react-three/postprocessing
1818
```
1919

2020
<p align="center">
21-
<a href="https://pqrpl.csb.app" target="_blank"><img width="274" src="bubbles.jpg" alt="Bubbles" /></a>
22-
<a href="https://5jgjz.csb.app" target="_blank"><img width="274" src="control.jpg" alt="Take Control" /></a>
21+
<a href="https://pmndrs.github.io/examples/bubbles" target="_blank"><img width="274" src="https://pmndrs.github.io/examples/bubbles/thumbnail.webp" alt="Bubbles" /></a>
22+
<a href="https://pmndrs.github.io/examples/take-control" target="_blank"><img width="274" src="https://pmndrs.github.io/examples/take-control/thumbnail.webp" alt="Take Control" /></a>
2323
</p>
2424
<p align="middle">
2525
<i>These demos are real, you can click them! They contain the full code, too. 📦</i>
@@ -49,14 +49,13 @@ get high performance crisp results w/o jagged edges.
4949
#### What does it look like?
5050

5151
Here's an example combining a couple of effects
52-
([live demo](https://codesandbox.io/s/react-postprocessing-dof-blob-pqrpl?)).
52+
([live demo](https://pmndrs.github.io/examples/bubbles)).
5353

54-
<a href="https://codesandbox.io/s/react-postprocessing-dof-blob-pqrpl?" target="_blank" rel="noopener">
55-
<img src="bubbles.jpg" alt="Bubbles Demo" />
54+
<a href="https://pmndrs.github.io/examples/bubbles" target="_blank" rel="noopener">
55+
<img src="https://pmndrs.github.io/examples/bubbles/thumbnail.webp" alt="Bubbles Demo" />
5656
</a>
5757

5858
```jsx
59-
import React from 'react'
6059
import { Bloom, DepthOfField, EffectComposer, Noise, Vignette } from '@react-three/postprocessing'
6160
import { Canvas } from '@react-three/fiber'
6261

0 commit comments

Comments
 (0)