From 4be5c8f0087482e61dffe41d768acc4a7b215d29 Mon Sep 17 00:00:00 2001 From: Aria Minaei Date: Fri, 25 Jun 2021 15:12:03 +0200 Subject: [PATCH] Docs: Added more details to @theatre/core|studio/README.md --- theatre/core/README.md | 19 +++++++++++++++++++ theatre/studio/README.md | 16 ++++++++-------- 2 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 theatre/core/README.md diff --git a/theatre/core/README.md b/theatre/core/README.md new file mode 100644 index 0000000..9373a02 --- /dev/null +++ b/theatre/core/README.md @@ -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 \ No newline at end of file diff --git a/theatre/studio/README.md b/theatre/studio/README.md index 9d46a74..0c6b50d 100644 --- a/theatre/studio/README.md +++ b/theatre/studio/README.md @@ -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. \ No newline at end of file