Skip to content

docs: Add detailed steps to instructions #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2022
Merged

docs: Add detailed steps to instructions #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
<!-- END YOUTUBE-CARDS -->
```

2. Create a file in your repo's `.github/workflows` folder and give it a name such as `youtube-cards.yml` with the following contents.
2. Create a folder named `.github` in your repository and inside create a folder named `workflows` if it does not exist.

3. Create a file in your repo's `.github/workflows/` folder and give it a name such as `youtube-cards.yml` with the following contents.

<!-- prettier-ignore-start -->
```yml
Expand All @@ -39,11 +41,12 @@ jobs:
- uses: DenverCoder1/github-readme-youtube-cards@main
with:
channel_id: UCipSxT7a3rn81vGLw9lqRkg
comment_tag_name: YOUTUBE-CARDS
```
<!-- prettier-ignore-end -->

Make sure to change the `channel_id` to your YouTube channel ID. See below for advanced configuration.
4. Make sure to change the `channel_id` to your YouTube channel ID.

See below for [advanced configuration](#advanced-configuration).

The [cron expression](https://crontab.cronhub.io/) in the example above is set to run at the top of every hour. The first time, you may want to [trigger the workflow manually](https://github.com/DenverCoder1/github-readme-youtube-cards/wiki/Running-the-GitHub-Action-Manually).

Expand Down