Updated README
This commit is contained in:
parent
0eec2041a3
commit
c439cfe947
3 changed files with 64 additions and 8 deletions
|
@ -24,8 +24,6 @@ You can use Theatre.js to:
|
||||||
|
|
||||||
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-generative.gif)
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-generative.gif)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* Or animate any other JS variable
|
* Or animate any other JS variable
|
||||||
|
|
||||||
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-console.gif)
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-console.gif)
|
||||||
|
@ -36,7 +34,7 @@ You can find the documentation and video tutorials [here](https://docs.theatrejs
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
Join us on [Discord](https://discord.gg/bm9f8F9Y9N) or write us an [email](mailto:hello@theatrejs.com).
|
Join us on [Discord](https://discord.gg/bm9f8F9Y9N), follow the updates on [twitter](https://twitter.com/AriaMinaei) or write us an [email](mailto:hello@theatrejs.com).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -1,11 +1,41 @@
|
||||||
# Theatre.js
|
# Theatre.js - Core
|
||||||
|
|
||||||
Theatre.js is a motion-graphics toolkit for the web. It comes with an animation library, and a visual editor.
|
Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance.
|
||||||
|
|
||||||
|
Theatre can be used both programmatically _and_ visually.
|
||||||
|
|
||||||
|
You can use Theatre.js to:
|
||||||
|
|
||||||
|
* Animate 3D objects made with THREE.js or other 3D libraries
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-3d-short.gif)
|
||||||
|
|
||||||
|
<sub>Art by [drei.lu](https://sketchfab.com/models/91964c1ce1a34c3985b6257441efa500)</sub>
|
||||||
|
|
||||||
|
* Animate HTML/SVG via React or other libraries
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-dom.gif)
|
||||||
|
|
||||||
|
* Design micro-interactions
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-micro-interaction.gif)
|
||||||
|
|
||||||
|
* Choreograph generative interactive art
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-generative.gif)
|
||||||
|
|
||||||
|
* Or animate any other JS variable
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-console.gif)
|
||||||
|
|
||||||
## Documentation and Tutorials
|
## Documentation and Tutorials
|
||||||
|
|
||||||
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Join us on [Discord](https://discord.gg/bm9f8F9Y9N), follow the updates on [twitter](https://twitter.com/AriaMinaei) or write us an [email](mailto:hello@theatrejs.com).
|
||||||
|
|
||||||
## `@theatre/core`
|
## `@theatre/core`
|
||||||
|
|
||||||
Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library.
|
Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library.
|
||||||
|
|
|
@ -1,13 +1,41 @@
|
||||||
# Theatre.js
|
# Theatre.js - Studio
|
||||||
|
|
||||||
Theatre.js is a motion-graphics toolkit for the web. It comes with an animation library, and a visual editor.
|
Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance.
|
||||||
|
|
||||||
Theatre works with all rendering stacks. You can use it to animate DOM elements, THREE.js objects, or any kind of JavaScript variable.
|
Theatre can be used both programmatically _and_ visually.
|
||||||
|
|
||||||
|
You can use Theatre.js to:
|
||||||
|
|
||||||
|
* Animate 3D objects made with THREE.js or other 3D libraries
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-3d-short.gif)
|
||||||
|
|
||||||
|
<sub>Art by [drei.lu](https://sketchfab.com/models/91964c1ce1a34c3985b6257441efa500)</sub>
|
||||||
|
|
||||||
|
* Animate HTML/SVG via React or other libraries
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-dom.gif)
|
||||||
|
|
||||||
|
* Design micro-interactions
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-micro-interaction.gif)
|
||||||
|
|
||||||
|
* Choreograph generative interactive art
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-generative.gif)
|
||||||
|
|
||||||
|
* Or animate any other JS variable
|
||||||
|
|
||||||
|
![s](https://raw.githubusercontent.com/AriaMinaei/theatre-docs/main/docs/.vuepress/public/preview-console.gif)
|
||||||
|
|
||||||
## Documentation and Tutorials
|
## Documentation and Tutorials
|
||||||
|
|
||||||
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
You can find the documentation and video tutorials [here](https://docs.theatrejs.com).
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Join us on [Discord](https://discord.gg/bm9f8F9Y9N), follow the updates on [twitter](https://twitter.com/AriaMinaei) or write us an [email](mailto:hello@theatrejs.com).
|
||||||
|
|
||||||
## `@theatre/studio`
|
## `@theatre/studio`
|
||||||
|
|
||||||
Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the editor, which is only used during design/development.
|
Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the editor, which is only used during design/development.
|
||||||
|
|
Loading…
Reference in a new issue