From 8b94c29844eea3e7120fc6ae11b214a54cf63875 Mon Sep 17 00:00:00 2001 From: Ray Villalobos Date: Thu, 27 Apr 2023 02:30:24 +0000 Subject: [PATCH] Added ReadMe file --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b034e7d..2235505 100644 --- a/README.md +++ b/README.md @@ -1 +1,49 @@ -# podcast-generator \ No newline at end of file +# Podcast Feed Generator + +A GitHub action to generate a podcast feed from a YAML file. YAML is much easier to read and write than XML, and this action will convert your YAML file into a valid podcast feed. +## Usage + +### Turn on Github Pages + +In your repository, go to Settings > Pages and select the main branch as the source. This will create a link to your page and give all of the content in the main branch a URL. Note the URL for the next step. + +### Create a YAML file + +Create a YAML file in your repository with the following format: + +```yaml +title: +subtitle: +author: +description: +link: +image: +language: +category: +format: +item: + - title: + description: + published: + file: + duration: + length: + ... Repeat for each episode +``` + +### Sample Workflow + +You're also going to need your own workflow file. Here's a sample: + +```yaml +name: Generate Feed +on: [push] +jobs: + generate-feed: + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v3 + - name: Run Feed Generator + uses: planetoftheweb/podcast-feed-generator@main +```