Skip to content

Commit

Permalink
docs: Update project info (#1)
Browse files Browse the repository at this point in the history
* docs: update

* docs: change logo

* docs: update readme
  • Loading branch information
hkonsti authored Mar 19, 2024
1 parent d1a74a4 commit afa9aaf
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 164 deletions.
130 changes: 0 additions & 130 deletions CONTRIBUTING.md

This file was deleted.

4 changes: 0 additions & 4 deletions FUNDING.yml

This file was deleted.

53 changes: 26 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
<br/>
<p align="center">
<a href="https://motion-canvas.github.io">
<a href="https://re.video">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://motion-canvas.github.io/img/logo_dark.svg">
<img width="180" alt="Motion Canvas logo" src="https://motion-canvas.github.io/img/logo.svg">
<source media="(prefers-color-scheme: dark)" srcset="./logo_dark.svg">
<img width="360" alt="Revideo logo" src="./logo.svg">
</picture>
</a>
</p>
<p align="center">
<a href="https://lerna.js.org"><img src="https://img.shields.io/badge/published%20with-lerna-c084fc?style=flat" alt="published with lerna"></a>
<a href="https://vitejs.dev"><img src="https://img.shields.io/badge/powered%20by-vite-646cff?style=flat" alt="powered by vite"></a>
<a href="https://www.npmjs.com/package/@motion-canvas/core"><img src="https://img.shields.io/npm/v/@motion-canvas/core?style=flat" alt="npm package version"></a>
<a href="https://chat.motioncanvas.io"><img src="https://img.shields.io/discord/1071029581009657896?style=flat&logo=discord&logoColor=fff&color=404eed" alt="discord"></a>
<a href="https://www.npmjs.com/package/@revideo/core"><img src="https://img.shields.io/npm/v/@revideo/core?style=flat" alt="npm package version"></a>
<a href="https://discord.com/invite/JDjbfp6q2G"><img src="https://img.shields.io/discord/1071029581009657896?style=flat&logo=discord&logoColor=fff&color=404eed" alt="discord"></a>
</p>
<br/>

# Motion Canvas
# Revideo - Make videos with AI

Motion Canvas is two things:
Revideo is

- A TypeScript library that uses generators to program animations.
- An editor providing a real-time preview of said animations.
- A typescript library to generate videos using AI
- A collection of API wrappers for services used in generated videos (e.g.
text-to-speech and text-to-image, see full list below)
- An editor to provide instant previews of generated videos
- Forked from the amazing Motion Canvas

It's a specialized tool designed to create informative vector animations and
synchronize them with voice-overs.
Think of LangChain, but for video

Aside from providing the preview, the editor allows you to edit certain aspects
of the animation which could otherwise be tedious.
## Using Revideo

## Using Motion Canvas
Check out our [getting started][docs] guide to learn how to use Revideo.

Check out our [getting started][docs] guide to learn how to use Motion Canvas.

## Developing Motion Canvas locally
## Developing Revideo locally

The project is maintained as one monorepo containing the following packages:

Expand Down Expand Up @@ -71,17 +70,17 @@ Canvas project that can be used during development.
To develop the player, first build the template: `npm run template:build`. Then,
start `npm run player:dev`.

## Installing a local version of Motion Canvas in a project
## Installing a local version of Revideo in a project

It can be useful to install a local version of Motion Canvas in a standalone
project. For example, when you want to use your own fork with some custom-made
features to create your animations.
It can be useful to install a local version of Revideo in a standalone project.
For example, when you want to use your own fork with some custom-made features
to create your animations.

Let's assume the following project structure:

```
projects/
├── motion-canvas/ <- your local monorepo
├── revideo/ <- your local monorepo
└── my-project/ <- a bootstrapped project
└── package.json
```
Expand All @@ -92,8 +91,8 @@ relative path to the package you want to link:

```diff
"dependencies": {
- "@motion-canvas/core": "^3.11.0",
+ "@motion-canvas/core": "file:../motion-canvas/packages/core",
- "@revideo/core": "^3.11.0",
+ "@revideo/core": "file:../revideo/packages/core",
// ...
},
```
Expand All @@ -103,7 +102,7 @@ to allow vite to load external files:

```ts
import {defineConfig} from 'vite';
import motionCanvas from '@motion-canvas/vite-plugin';
import motionCanvas from '@revideo/vite-plugin';

export default defineConfig({
server: {
Expand All @@ -127,10 +126,10 @@ You can use the same technique to test out any custom package you're working on.
## Contributing

Read through our [Contribution Guide](./CONTRIBUTING.md) to learn how you can
help make Motion Canvas better.
help make Revideo better.

[authenticate]:
https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token
[template]: https://github.com/motion-canvas/project-template#using-the-template
[discord]: https://chat.motioncanvas.io
[discord]: https://discord.com/invite/JDjbfp6q2G
[docs]: https://motioncanvas.io/docs/quickstart
9 changes: 6 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@

## Supported Versions

Motion Canvas does not provide a long-term security support for any of its older
Revideo does not provide a long-term security support for any of its older
versions. Only the newest release is being supported with security updates.

## Reporting a Vulnerability

**Please do not report security vulnerabilities through public GitHub issues.**

Instead, please kindly email us at
[[email protected]](mailto:[email protected])
Instead, please kindly email us at [[email protected]](mailto:[email protected])

We are a fork of Motion Canvas, so should you find a security vulnerability that
affects both projects, please also contact them at
[[email protected]](mailto:[email protected])

After receiving a report, we will try to confirm the problem. You should receive
a response within 48 hours, informing you about our plans concerning the
Expand Down
6 changes: 6 additions & 0 deletions logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit afa9aaf

Please sign in to comment.