|
1 | | - |
| 1 | +# ⚠️ This repository has been archived |
2 | 2 |
|
3 | | -<p align="center"> |
4 | | - <a href="https://www.npmjs.com/package/@tresjs/core"><img src="https://img.shields.io/npm/v/@tresjs/post-processing?color=FF7BAC" alt="npm package"></a> |
5 | | - <a href="https://www.npmjs.com/package/@tresjs/post-processing"><img src="https://img.shields.io/npm/dm/@tresjs/post-processing?color=FF7BAC" alt="npm downloads"></a> |
6 | | - <a href="https://discord.gg/UCr96AQmWn"><img src="https://img.shields.io/badge/chat-discord-purple?style=flat&logo=discord" alt="discord chat"></a> |
7 | | -</p> |
8 | | -<br/> |
| 3 | +This package has been moved to the TresJS monorepo. |
9 | 4 |
|
10 | | -# Post-Processing |
| 5 | +## New Location |
11 | 6 |
|
12 | | -> Collection of useful helpers and fully functional, ready-made post-processing effects for Tres |
| 7 | +👉 **[github.com/Tresjs/tres](https://github.com/Tresjs/tres)** |
13 | 8 |
|
14 | | -- 💡 Build your effects with Vue components only. |
15 | | -- ⚡️ Powered by Vite |
16 | | -- 🦾 Fully Typed |
| 9 | +All future development, issues, and pull requests should be directed to the monorepo. |
17 | 10 |
|
18 | 11 | ## Installation |
19 | 12 |
|
20 | | -```bash |
21 | | -pnpm i @tresjs/post-processing |
22 | | -``` |
23 | | - |
24 | | -## Docs |
25 | | - |
26 | | -Checkout the [docs](https://post-processing.tresjs.org/) |
27 | | - |
28 | | -## Demos |
29 | | - |
30 | | -- [Stackblitz Collection](https://stackblitz.com/@alvarosabu/collections/tresjs) |
31 | | - |
32 | | -## Contributing |
33 | | - |
34 | | -We are open to contributions, please read the [contributing guide](https://github.com/Tresjs/tres/blob/main/CONTRIBUTING.md) to get started. |
35 | | - |
36 | | -### Build |
37 | | - |
38 | | -To build the package run: |
| 13 | +The package is still available on npm with the same name. Installation instructions remain the same: |
39 | 14 |
|
40 | 15 | ```bash |
41 | | -pnpm run build |
42 | | -``` |
43 | | - |
44 | | -### Playground |
45 | | - |
46 | | -To run the playground run, its a great way to test the components and helpers locally: |
47 | | - |
48 | | -First install dependencies |
49 | | - |
50 | | -``` |
51 | | -pnpm i |
| 16 | +pnpm add @tresjs/post-processing |
52 | 17 | ``` |
53 | 18 |
|
54 | | -And then to run the development server on http://localhost:5173 |
55 | | - |
56 | | -```bash |
57 | | -pnpm run playground |
58 | | -``` |
59 | | - |
60 | | -### Docs |
61 | | - |
62 | | -To run de docs in dev mode |
63 | | - |
64 | | -```bash |
65 | | -pnpm run docs:dev |
66 | | -``` |
67 | | - |
68 | | -To build them |
69 | | - |
70 | | -```bash |
71 | | -pnpm run docs:build |
72 | | -``` |
73 | | - |
74 | | -## License |
75 | | - |
76 | | -[MIT](/LICENSE) |
77 | | - |
78 | | -## Sponsors |
| 19 | +## Documentation |
79 | 20 |
|
80 | | -Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️ |
| 21 | +📚 Visit [docs.tresjs.org](https://docs.tresjs.org) for the latest documentation. |
0 commit comments