Skip to content

Commit

Permalink
Readme update (#52)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
Tinoooo and Tino Koch committed Sep 28, 2023
1 parent 4ec3156 commit 19d2e7e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 89 deletions.
77 changes: 0 additions & 77 deletions CONTRIBUTING.md

This file was deleted.

17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,14 @@
</p>
<br/>

# Post-Processing WIP
# Post-Processing

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

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.

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.

It just works. 💯

## Installation

```bash
Expand All @@ -31,15 +24,15 @@ pnpm i @tresjs/post-processing

## Docs

Checkout the [docs](https://cientos.tresjs.org/)
Checkout the [docs](https://postprocessing.tresjs.org/)

## Demos

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

## Contributing

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

### Build

Expand Down

0 comments on commit 19d2e7e

Please sign in to comment.