From ceaa4f65528b0ae34daec6d37b14f77752fd8226 Mon Sep 17 00:00:00 2001 From: Greg Brimble Date: Sat, 25 Apr 2020 17:02:11 +0100 Subject: [PATCH] Update README.md with clearer instructions --- README.md | 55 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index fa7ec9f..fa9aeba 100644 --- a/README.md +++ b/README.md @@ -6,33 +6,34 @@ ## Usage -As a part of your [GitHub Actions](https://github.com/features/actions) workflow, add a new step as follows: - -```yml -name: Update -on: - push: - schedule: - - cron: "0 0 * * *" # Every day at midnight -jobs: - deploy: - name: Update - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - name: Run crawler - uses: gregbrimble/tailwindui-crawler-action@v1.0.0 - with: - email: ${{ secrets.TAILWINDUI_EMAIL }} - password: ${{ secrets.TAILWINDUI_PASSWORD }} -``` - -Read more about the schedule cron syntax in [the official GitHub Actions documentation](https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule). - -We strongly advise utilizing [GitHub Actions secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) to securely store your TailwindUI email and password. - -A full example can be found in [`.github/workflows/default.yml`](https://github.com/GregBrimble/tailwindui-crawler-action/blob/master/.github/workflows/default.yml). +1. [Create a **private** GitHub repository](https://github.com/new/). +1. [Add `TAILWINDUI_EMAIL` and `TAILWINDUI_PASSWORD` secrets to the GitHub repository](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets). +1. [Optionally create a `.env` file with additional settings for the crawler](https://github.com/kiliman/tailwindui-crawler#%EF%B8%8F-example-env-file). +1. Create a new file `.github/workflows/default.yml`: + + ```yml + name: Update + on: + push: + schedule: + - cron: "0 0 * * *" # Every day at midnight + jobs: + deploy: + name: Update + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Run crawler + uses: gregbrimble/tailwindui-crawler-action@v1.0.0 + with: + email: ${{ secrets.TAILWINDUI_EMAIL }} + password: ${{ secrets.TAILWINDUI_PASSWORD }} + ``` + + Read more about the schedule cron syntax in [the official GitHub Actions documentation](https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule). + +A live example can be found in [`.github/workflows/default.yml`](https://github.com/GregBrimble/tailwindui-crawler-action/blob/master/.github/workflows/default.yml). ## Advanced