Skip to content

Commit 19d2e7e

Browse files
TinooooTino Koch
andauthored
Readme update (#52)
* feature: added eslint rules to have homogeneous rules in the tres ecosystem * chore: applied eslint fixes * chore: updated readme file --------- Co-authored-by: Tino Koch <tino.koch@xpoli.eu>
1 parent 4ec3156 commit 19d2e7e

File tree

2 files changed

+5
-89
lines changed

2 files changed

+5
-89
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,14 @@
88
</p>
99
<br/>
1010

11-
# Post-Processing WIP
11+
# Post-Processing
1212

13-
> Collection of useful helpers and fully functional, ready-made abstractions for Tres
13+
> Collection of useful helpers and fully functional, ready-made post-processing effects for Tres
1414
15-
- 💡 Build a 3D scene working only with Vue components.
15+
- 💡 Build your effects with Vue components only.
1616
- ⚡️ Powered by Vite
17-
- 🥰 It brings all the updated features of ThreeJS right awayregardless the version
1817
- 🦾 Fully Typed
1918

20-
Cientos (Spanish word for "hundreds", pronounced /θjentos/ ) is is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word uses in spanish to multiply by 100, to refer to the potential reach of the package to hold a amazing abstractions.
21-
22-
The postprocessing package uses three-stdlib module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalogue of components using the extend method from the `core`, postprocessing does it for you.
23-
24-
It just works. 💯
25-
2619
## Installation
2720

2821
```bash
@@ -31,15 +24,15 @@ pnpm i @tresjs/post-processing
3124

3225
## Docs
3326

34-
Checkout the [docs](https://cientos.tresjs.org/)
27+
Checkout the [docs](https://postprocessing.tresjs.org/)
3528

3629
## Demos
3730

3831
- [Stackblitz Collection](https://stackblitz.com/@alvarosabu/collections/tresjs)
3932

4033
## Contributing
4134

42-
We are open to contributions, please read the [contributing guide](/CONTRIBUTING.md) to get started.
35+
We are open to contributions, please read the [contributing guide](https://github.com/Tresjs/tres/blob/main/CONTRIBUTING.md) to get started.
4336

4437
### Build
4538

0 commit comments

Comments
 (0)