|
1 | | -# @raae/gatsby-plugin-starter |
| 1 | +# @raae/gatsby-source-youtube-oembed |
2 | 2 |
|
3 | | -_A starter to bootstrap your next Gatsby Plugin_ |
4 | | -_— automatic release to npm with semantic-release out of the box_ |
| 3 | +> Source YouTube information without an API key using the oEmbed endpoint 📺 |
5 | 4 |
|
6 | | - |
| 5 | +## How to install |
7 | 6 |
|
8 | | -[](https://twitter.com/Ash_Hitchcock/status/1471048277747548163?s=20&t=YKN2khQAbqaLSSccqculsw) |
| 7 | +`npm install @raae/gatsby-source-youtube-oembed` |
9 | 8 |
|
10 | | - |
11 | | -**Heads up:** This package is not ment to be used as a Gatsby Plugin, it's a template for you to start from. |
| 9 | +or |
12 | 10 |
|
13 | | - |
| 11 | +`yarn add @raae/gatsby-source-youtube-oembed` |
14 | 12 |
|
15 | | -## A message or two or three from Queen Raae 👑 |
| 13 | +## How to use |
16 | 14 |
|
17 | | -### 1-on-1 Emergency Gatsby Call |
| 15 | +``` |
| 16 | +module.exports = { |
| 17 | + plugins: [ |
| 18 | + `@raae/gatsby-source-youtube-oembed` |
| 19 | + ], |
| 20 | +} |
| 21 | +``` |
18 | 22 |
|
19 | | -Are you stuck on a reef in the sharky waters around the Gatsby islands? Check out [1-on-1 Emergency Gatsby Call](https://queen.raae.codes/gatsby-emergency/) with Queen Raae to get friendly advice you can put into action immediately from a seasoned Gatsby developer. |
| 23 | +## Questions, Feedback and Suggestions |
20 | 24 |
|
21 | | -### Stay updated and get the most out of Gatsby |
22 | | - |
23 | | -Learn how to get the most out of Gatsby and **stay updated** on the template by [subscribing](https://queen.raae.codes/emails/?utm_source=readme&utm_campaign=plugin-starter) to daily emails from Queen Raae and Cap'n Ola. |
24 | | - |
25 | | -### Video Walkthrough |
26 | | - |
27 | | -Watch Queen Raae use this starter to create a new Gatsby plugin in a unauthorized and rum-fueled [treasure hunt](https://youtu.be/eaZm9MC0GeE) in the sharky waters around the Gatsby islands on [YouTube](https://youtu.be/eaZm9MC0GeE). |
28 | | - |
29 | | - |
30 | | - |
31 | | -## Create your next Gatsby Plugin |
32 | | - |
33 | | -### Get started |
34 | | - |
35 | | -1. [Use this template](https://github.com/queen-raae/gatsby-plugin-starter/generate) to create a new repository based on the code in this repository, but with a clean history. There is no need to drag all the commits of this repository by forking. |
36 | | -2. Select the correct owner and give it a name according to the [Gatsby Plugin naming standard](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/naming-a-plugin). |
37 | | -3. Clone your new repository onto your machine for development and run `yarn install` |
38 | | - |
39 | | -### Make it yours |
40 | | - |
41 | | -1. Make the readme template the root template (`mv README_TEMPLATE.md README.md`) |
42 | | -2. Delete the changelog (`rm CHANGELOG.md`) |
43 | | -3. Search and replace `@raae/gatsby-plugin-starter` with the name of your plugin |
44 | | -4. Search and replace `github.com/queen-raae/gatsby-plugin-starter` with the link to your repository |
45 | | -5. Search and replace `[email protected]` with your email address |
46 | | -6. Search and replace `@raae` with your GitHub username |
47 | | -7. Change the description in `plugin/package.json` |
48 | | -8. Change the tag line in `README.md` |
49 | | -9. Commit changes `git commit -a -m "chore: rename all the things"` |
50 | | -10. Create an initial tag (`git tag v0.0.0 -a -m "Initial tag"`) and push it (`git push origin --tags`) |
51 | | - |
52 | | -### Develop and test |
53 | | - |
54 | | -Check the `CONTRIBUTING.md` file. |
55 | | - |
56 | | -### Release |
57 | | - |
58 | | -The project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [semantic versioning](https://semver.org/) to automate releases by utalizing the [semantic-release](https://semantic-release.gitbook.io/) project and GitHub Actions. |
59 | | - |
60 | | -As the project owner, you need to add an NPM token to your repository secrets so that Semantic Release can do its thing 💪 |
61 | | - |
62 | | -- Create an automation access token on [npmjs.com/](https://www.npmjs.com/) (Avatar -> Access Token). |
63 | | -- Add `NPM_TOKEN` to your repository secrets (Settings -> Secret -> Action) with the value from above. |
64 | | - |
65 | | -#### Semantic Release Settings |
66 | | - |
67 | | -Commits to the main branch will result in a new release while committing to a next branch will result in a pre-release. The releases follow [Semantic Versioning](https://semver.org/), and [your commit messages](https://github.com/semantic-release/commit-analyzer) will decide the following version number. |
68 | | - |
69 | | -- Commits message titles prefixed by `fix:`, `fix(<scope>):` and `docs(README):` will result in a patch version update |
70 | | -- Commits message titles prefixed by `feat:`, `feat(<scope>):` will result in a minor version update |
71 | | -- Commits message footers containing `BREAKING CHANGE:` or `BREAKING CHANGES:` will result in a major version update |
72 | | - |
73 | | -In addition to automating releases, Semantic Release creates and updates a `CHANGELOG.md` based on the above commit rules. |
74 | | - |
75 | | -Check the `.releaserc` file, the `.github/workflows/release.yml` and the [Semantic Release documentation](https://semantic-release.gitbook.io/) for more details. |
76 | | - |
77 | | - |
78 | | - |
79 | | -## Questions, Feedback, and Suggestions |
80 | | - |
81 | | -If you have any questions, feedback, or suggestions, head on over to [discussions](https://github.com/queen-raae/gatsby-plugin-starter/discussions). |
| 25 | +If you have any questions, feedback or suggestions head on over to [discussions](https://github.com/queen-raae/gatsby-source-youtube-oembed/discussions). |
82 | 26 |
|
83 | 27 | ## Found a bug? |
84 | 28 |
|
85 | | -If you find a bug, please open an [issue](https://github.com/queen-raae/gatsby-plugin-starter/issues) and create a pull request to fix it if you are able. |
| 29 | +If you find a bug please open an [issue](https://github.com/queen-raae/gatsby-source-youtube-oembed/issues) and/or create a pull request to fix it. |
0 commit comments