Skip to content

Commit

Permalink
Update README with setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinnl committed Jul 5, 2021
1 parent cef6ad3 commit 3fec98a
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,30 @@

You can fork this repository and edit `feeds.toml` to start generating your own
RSS feeds.

# Automatically generate feeds

## On GitHub

To automatically generate feeds twice a day on GitHub:

1. Fork this repository and edit `feeds.toml`.
2. Create a branch called `gh-pages`.
3. Visit [/actions](./actions), then enable workflows for your fork.

GitHub Actions will then automatically run twice a day to check for updates,
and publish your feeds at `https://<username>.github.io/feeds/`.

## On GitLab

To automatically generate feeds on GitLab:

1. Fork this repository and edit `feeds.toml`.
2. [Create a new pipeline schedule](./-/pipeline_schedules/new) (CI/CD ˃
Schedules).
3. Set it to your desired interval (e.g. `30 5,17 * * *` to run at 5:30 and
17:30).
4. Hit "Save pipeline schedule".

GitLab CI/CD will then automatically run at your selected interval to check for
updates, and publish your feeds at `https://<username>.gitlab.io/feeds/`.

0 comments on commit 3fec98a

Please sign in to comment.