Skip to content

Commit

Permalink
docs: mark as beta and link usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
axe312ger committed Nov 2, 2020
1 parent 91d50ec commit 8438fcc
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion packages/gatsby-transformer-video/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> Convert videos via FFMPEG. Easily convert & host **small** videos on your own.
# This is a beta plugin. See: https://github.com/gatsbyjs/gatsby/pull/15783

:warning: Converting videos might take a lot of time. Make sure to have an effective caching mechanism in place. See [caching](#caching)

## Features
Expand All @@ -13,6 +15,10 @@
- Create video conversion profiles. Create a converter function using `fluent-ffmpeg` to unlock all FFMPEG features.
- Take screenshots at any position of the video

## Usage example

https://github.com/gatsbyjs/gatsby/tree/gatsby-transformer-video/examples/using-gatsby-transformer-video

## Installation

```sh
Expand Down Expand Up @@ -93,7 +99,7 @@ module.exports = {
profiles: {
sepia: {
extension: `mp4`,
converter: function({ ffmpegSession, videoStreamMetadata }) {
converter: function ({ ffmpegSession, videoStreamMetadata }) {
// Example:
// https://github.com/gatsbyjs/gatsby/blob/gatsby-transformer-video/examples/using-gatsby-transformer-video/gatsby-config.js
},
Expand Down

0 comments on commit 8438fcc

Please sign in to comment.