UNPKG

3.03 kBMarkdownView Raw
1<p align="center">
2 <a href="https://github.com/remotion-dev/logo">
3 <picture>
4 <source media="(prefers-color-scheme: dark)" srcset="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-dark.gif">
5 <img alt="Animated Remotion Logo" src="https://github.com/remotion-dev/logo/raw/main/animated-logo-banner-light.gif">
6 </picture>
7 </a>
8</p>
9
10[![Discord Shield](https://img.shields.io/discord/809501355504959528?color=000000&label=Discord&logo=fdgssdf)](https://remotion.dev/discord)
11[![NPM Version](https://img.shields.io/npm/v/remotion.svg?style=flat&color=black)](https://www.npmjs.org/package/remotion)
12[![NPM Downloads](https://img.shields.io/npm/dm/remotion.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/remotion?minimal=true)
13[![Open Bounties](https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Fremotion%2Fbounties%3Fstatus%3Dopen&style=flat&color=black&labelColor=grey&label=Open+Bounties)](https://github.com/remotion-dev/remotion/issues?q=is%3Aopen+label%3A%22%F0%9F%92%8E+Bounty%22+sort%3Aupdated-desc)
14<a href="https://twitter.com/remotion"><img src="https://img.shields.io/twitter/follow/remotion?label=Twitter&color=black" alt="Twitter"></a>
15
16Remotion is a framework for **creating videos programmatically using React.**
17
18## Why create videos in React?
19
20- **Leverage web technologies**: Use all of CSS, Canvas, SVG, WebGL, etc.
21- **Leverage programming**: Use variables, functions, APIs, math and algorithms to create new effects
22- **Leverage React**: Reusable components, Powerful composition, Fast Refresh, Package ecosystem
23
24## Created with Remotion
25
26<table>
27<tr>
28<td align="center">
29<img style="width: 290px" src="packages/docs/static/img/fireship-quick.gif" />
30<p>"This video was made with code" <em>- Fireship</em> <a href="https://youtu.be/deg8bOoziaE">Watch</a> • <a href="https://github.com/wcandillon/remotion-fireship">Source</a></p>
31</td>
32<td align="center">
33<img style="width: 240px" src="packages/docs/static/img/unwrapped-2023.gif" />
34<p>GitHub Unwrapped - Personalized Year in Review <a href="https://www.githubunwrapped.com">Try</a> • <a href="https://github.com/remotion-dev/github-unwrapped-2023">Source</a></p>
35</td>
36<td align="center">
37<em>View more in the <a href="https://remotion.dev/showcase">Remotion Showcase</a>!</em>
38</td>
39</tr>
40</table>
41
42## Get started
43
44If you already have Node.JS installed, type
45
46```console
47npx create-video@latest
48```
49
50to get started. Otherwise, read the [installation page](https://www.remotion.dev/docs/) in the documentation.
51
52## Documentation
53
54Documentation: [**remotion.dev/docs**](https://www.remotion.dev/docs)
55API Reference: [**remotion.dev/api**](https://www.remotion.dev/api)
56
57## License
58
59Be aware of that Remotion has a special license and requires obtaining a company license in some cases. Read the [LICENSE](LICENSE.md) page for more information.
60
61## Contributing
62
63Please read [CONTRIBUTING.md](CONTRIBUTING.md) to learn about contributing to this project.