etro 0.6.0

package/README.md

@@ -0,0 +1,57 @@
+# Etro
+
+[![](https://img.shields.io/npm/v/etro)](https://www.npmjs.com/package/etro)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fetro-js%2Fetro%2Fbadge&style=flat)](https://actions-badge.atrox.dev/etro-js/etro/goto)
+
+> A video editor for developers
+
+![Screenshot](screenshots/2019-08-17_0.png)
+
+Etro is a completely in-browser video-editing library. Similar to conventional video-editing software, it lets you layer media and other content on a timeline. Audio, image, video and other tracks are supported, along with powerful video and audio manipulation to existing tracks. Being very flexible and extendable, you can choose to only use the core components or define your own.
+
+## Features
+
+- Export video to blob
+- Write your own layers and effects
+- Write a function for a property
+- Keyframes
+- Built-in hardware accelerated visual effects
+- More coming soon
+
+## Usage
+
+```html
+<script src="https://unpkg.com/etro@latest/dist/etro.js"></script>
+```
+
+Then, to create a movie (which is a project)
+```js
+const movie = new etro.Movie(canvas);
+```
+
+Then, add layers
+```js
+movie
+  // add an empty blue layer starting at 0s and lasting 3s and filling the entire screen
+  .addLayer(new etro.layer.Base(0, 3, {background: 'blue'}))
+  // add a cropped video layer starting at 2.5s
+  .addLayer(new etro.layer.Video(2.5, video, {mediaX: 10, mediaY: -25}));
+```
+
+To start the movie, just like any ol' `<video>` or `<audio>`, use `.play()`
+```js
+movie.play();
+```
+
+## License
+
+Distributed under GNU General Public License v3. See `LICENSE` for more information.
+
+## Further Reading
+
+- [Documentation](https://etrojs.dev)
+- [Wiki (WIP)](https://github.com/etro-js/etro/wiki)
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md)