Skip to content

Commit 8438fcc

Browse files
committed
docs: mark as beta and link usage example
1 parent 91d50ec commit 8438fcc

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

packages/gatsby-transformer-video/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Convert videos via FFMPEG. Easily convert & host **small** videos on your own.
44
5+
# This is a beta plugin. See: https://github.com/gatsbyjs/gatsby/pull/15783
6+
57
:warning: Converting videos might take a lot of time. Make sure to have an effective caching mechanism in place. See [caching](#caching)
68

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

18+
## Usage example
19+
20+
https://github.com/gatsbyjs/gatsby/tree/gatsby-transformer-video/examples/using-gatsby-transformer-video
21+
1622
## Installation
1723

1824
```sh
@@ -93,7 +99,7 @@ module.exports = {
9399
profiles: {
94100
sepia: {
95101
extension: `mp4`,
96-
converter: function({ ffmpegSession, videoStreamMetadata }) {
102+
converter: function ({ ffmpegSession, videoStreamMetadata }) {
97103
// Example:
98104
// https://github.com/gatsbyjs/gatsby/blob/gatsby-transformer-video/examples/using-gatsby-transformer-video/gatsby-config.js
99105
},

0 commit comments

Comments
 (0)