From c439cfe947bd5f4ec27f148194aadc7b7b591221 Mon Sep 17 00:00:00 2001 From: Aria Minaei Date: Fri, 1 Oct 2021 12:38:43 +0200 Subject: [PATCH] Updated README --- README.md | 4 +--- theatre/core/README.md | 34 ++++++++++++++++++++++++++++++++-- theatre/studio/README.md | 34 +++++++++++++++++++++++++++++++--- 3 files changed, 64 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 16aee5b..e126e0d 100644 --- a/README.md +++ b/README.md @@ -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) - - * Or animate any other JS variable ![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 -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 diff --git a/theatre/core/README.md b/theatre/core/README.md index 7e276ad..3aa12f1 100644 --- a/theatre/core/README.md +++ b/theatre/core/README.md @@ -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) + + Art by [drei.lu](https://sketchfab.com/models/91964c1ce1a34c3985b6257441efa500) + +* 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 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 comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library. diff --git a/theatre/studio/README.md b/theatre/studio/README.md index 68c2c8c..a48607e 100644 --- a/theatre/studio/README.md +++ b/theatre/studio/README.md @@ -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) + + Art by [drei.lu](https://sketchfab.com/models/91964c1ce1a34c3985b6257441efa500) + +* 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 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 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.