Skip to content

Commit

Permalink
docs(README): add options documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raae committed Feb 3, 2022
1 parent 7846701 commit 8a6ca28
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,30 @@ module.exports = {
}
```

## Plugin Options

### YouTube Ids

Add the YouTube ids for the videos you would like to source!
**Type:** An array of YouTube ids
**Example:** `["Bk1jonYPFD4", "TzJfepDjpzM"]`
**Default:** `[]`

```
// gatsby.config.js
module.exports = {
plugins: [
{
resolve: "@raae/gatsby-source-youtube-oembed",
options: {
youTubeIds: ["Bk1jonYPFD4", "TzJfepDjpzM"],
},
},
],
};
```

## Questions, Feedback and Suggestions

If you have any questions, feedback or suggestions head on over to [discussions](https://github.com/queen-raae/gatsby-source-youtube-oembed/discussions).
Expand Down

0 comments on commit 8a6ca28

Please sign in to comment.