variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: Added more details to @theatre/core|studio/README.md

Browse source
This commit is contained in:
Aria Minaei 2021-06-25 15:12:03 +02:00
parent 3950f34533
commit 4be5c8f008
2 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
theatre/core/README.md Normal file
View file

@ -0,0 +1,19 @@
# Theatre.js
Theatre.js is a motion-graphics toolkit for the web. It comes with an animation library, and a visual editor.
## Docs
Docs are [on github](https://github.com/AriaMinaei/theatre).
## `@theatre/core`
Theatre comes in two packages: `@theatre/core` (the library) and `@theatre/studio` (the editor). This package is the core library.
## Bundle size
`@theatre/core` is currently around 20KiB compressed with all its dependencies.
## License
Apache 2.0

16
theatre/studio/README.md
View file

@ -1,20 +1,20 @@
# Theatre.js
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:
![Video showing a browser window containing three divs falling from the middle of the screen, and bouncing back up, animated with the help of Theatre.js](https://docs.theatrejs.com/public/preview-1.gif)
Theatre.js is a motion-graphics toolkit for the web. It comes with an animation library, and a visual editor.
Theatre works with all rendering stacks. You can use it to animate DOM elements, THREE.js objects, or any kind of JavaScript variable.
## Guide
## Docs
TODO
Docs are [on github](https://github.com/AriaMinaei/theatre).
## `@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.
## License
Your use of Theatre.js is governed under the Apache License Version 2.0:
* Theatre's core (`@theatre/core`) is released under the Apache License. Same goes for most packages in this repository.
* Theatre's core (`@theatre/core`) is released under the Apache License.
* The studio (`@theatre/studio`) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes `@theatre/core`, so only the Apache License applies.