Skip to content

Commit 3bafbfb

Browse files
committed
Update README.md: Add benchmarks and refine layer-based system description
1 parent 82345f9 commit 3bafbfb

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ This project owes much to [@Vanilagy's](https://github.com/Vanilagy) exceptional
3232
npm install @diffusionstudio/core
3333
```
3434

35+
## Benchmarks
36+
![Benchmarks](./assets/benchmarks.png)
37+
3538
## Basic Usage
3639
Here’s an example of how to use the library:
3740

@@ -55,16 +58,12 @@ const composition = new core.Composition(); // 1920x1080
5558

5659
// this is how to compose your clips
5760
await composition.add(video); // convenience function for
58-
await composition.add(text); // clip -> track -> composition
61+
await composition.add(text); // clip -> layer -> composition
5962

6063
await new core.Encoder(composition).render('hello_world.mp4');
6164
```
6265

63-
The API models the structure of conventional video editing applications like Adobe Premiere or CapCut, using a track-based system. The current state can be visualized like this:
64-
65-
![Composition Visulization](./assets/composition.png)
66-
67-
Each layer contains zero or more clips of a single type, arranged in ascending chronological order.
66+
The API models the structure of conventional video editing applications like Adobe Premiere or CapCut, using a layer-based system. Each layer contains zero or more clips of a single type, arranged in ascending chronological order.
6867

6968
Layers are created implicitly with `composition.add(clip)`, but you can also create them manually:
7069

@@ -172,4 +171,3 @@ For any questions, feel free to [contact us](https://diffusion.studio).
172171
### v4.x _(Estimated Release: July 2025)_
173172
- **Source code access by invite only** (Commercial & Non-Commercial license)
174173
- Introducing a custom WebGL2 renderer
175-

assets/benchmarks.png

49.1 KB
Loading

0 commit comments

Comments
 (0)