Browse Source

update readme

stateless
Mikael Finstad 6 years ago
parent
commit
d28436250b
  1. 6
      README.md
  2. 41
      examples/README.md

6
README.md

@ -22,12 +22,16 @@ Inspired by [ffmpeg-concat](https://github.com/transitive-bullshit/ffmpeg-concat
- Accepts custom HTML5 Canvas / Fabric.js JavaScript code for custom screens or dynamic overlays
- Render custom GL shaders (for example from [shadertoy](https://www.shadertoy.com/))
- Can output GIF
- Preserve audio sources or mix multiple
- Overlay transparent images or videos
- Show different sub-clips for parts of a clips duration (B-roll)
## Use cases
- Create a slideshow from a set of pictures with text overlay
- Create a fast-paced trailer or promo video
- Create a tutorial video with help text
- Create news stories
- Simply convert a video to a GIF
- Resize video to any size or framerate and with automatic letterboxing/cropping (e.g. if you need to upload a video somewhere but the site complains `Video must be 1337x1000 30fps`)
@ -119,7 +123,7 @@ Edit specs are JavaScript / JSON objects describing the whole edit operation wit
},
},
audioFilePath,
keepSourceAudio,
keepSourceAudio: false,
clips: [
{
transition,

41
examples/README.md

@ -1,54 +1,52 @@
# Examples
## Ken Burns zoom slideshow
## Image slideshow with Ken Burns zoom
![](https://github.com/mifi/gifs/raw/master/kenburns.gif)
[kenBurns.json5](https://github.com/mifi/editly/blob/master/examples/kenBurns.json5)
```bash
editly kenBurns.json5
```
## News title
![](https://github.com/mifi/gifs/raw/master/newsTitle.gif)
[newsTitle.json5](https://github.com/mifi/editly/blob/master/examples/newsTitle.json5)
```bash
editly newsTitle.json5
```
## Resize modes
![](https://github.com/mifi/gifs/raw/master/resizeHorizontal.gif)
[resizeHorizontal.json5](https://github.com/mifi/editly/blob/master/examples/resizeHorizontal.json5)
```bash
editly resizeHorizontal.json5
```
## Speed up / slow down with cutting
![](https://github.com/mifi/gifs/raw/master/speedTest.gif)
[speedTest.json5](https://github.com/mifi/editly/blob/master/examples/speedTest.json5)
```bash
editly speedTest.json5
```
## Title and subtitle
![](https://github.com/mifi/gifs/raw/master/subtitle.gif)
[subtitle.json5](https://github.com/mifi/editly/blob/master/examples/subtitle.json5)
```bash
editly subtitle.json5
```
## Video overlays with alpha channel
[alpha.json5](https://github.com/mifi/editly/blob/master/examples/alpha.json5)
## Image overlays with alpha channel
[imageOverlay.json5](https://github.com/mifi/editly/blob/master/examples/imageOverlay.json5)
## Partial overlays (B-roll)
[visibleFromUntil.json5](https://github.com/mifi/editly/blob/master/examples/visibleFromUntil.json5)
## Audio layers
- [audio1.json5](https://github.com/mifi/editly/blob/master/examples/audio1.json5)
- [audio2.json5](https://github.com/mifi/editly/blob/master/examples/audio2.json5)
## Custom HTML5 canvas Javascript
@ -56,7 +54,6 @@ editly subtitle.json5
[customCanvas.js](https://github.com/mifi/editly/blob/master/examples/customCanvas.js)
```bash
node customCanvas.js
```
@ -67,11 +64,11 @@ node customCanvas.js
[customFabric.js](https://github.com/mifi/editly/blob/master/examples/customFabric.js)
```bash
node customFabric.js
```
## LosslessCut tutorial
[This video](https://www.youtube.com/watch?v=pYHMxXy05Jg) was created with [losslesscut.json5](https://github.com/mifi/editly/blob/master/examples/losslesscut.json5)
Loading…
Cancel
Save