From 7054e072dd1f9552ba9ee834817f9fbf15feb07b Mon Sep 17 00:00:00 2001 From: Greg Brimble Date: Thu, 15 Apr 2021 16:42:15 +0100 Subject: [PATCH] Update documentation --- .env.example | 27 ++------------------------- README.md | 30 ++++++++++++++++-------------- 2 files changed, 18 insertions(+), 39 deletions(-) diff --git a/.env.example b/.env.example index eb3340e..a3969b7 100644 --- a/.env.example +++ b/.env.example @@ -2,28 +2,5 @@ # At the time of writing, killman/tailwindui-crawler supports the following. # However, new features should also be supported, assuming you are using an up-to-date version of the crawler. -HTMLMODE=alpine # alpine | comments -BUILDINDEX=1 # 0 | 1 - -TRANSFORMERS=addTailwindCss,prefixSrc,useInter,changeColor,changeLogo,prefixClasses,convertReact,stripAlpine - -# addTailwindCss -ADDTAILWINDCSS_URL=http://localhost/path/to/css # defaults to twui CDN - -# convertVue -VUE_OUTPUT=$OUTPUT/vue # path to save Vue files (defaults to $OUTPUT) - -# convertReact -CONVERTREACT_OUTPUT=$OUTPUT/react # path to save React files (default to $OUTPUT) - -# stripAlpine -STRIPALPINE_OUTPUT=$OUTPUT/no-alpine # path to save stripped HTML files (REQUIRED) - -# changeColor -CHANGECOLOR_TO=red # name of color to change from indigo - -# changeLogo -CHANGELOGO_URL=http://localhost/path/to/logo # URL of logo (defaults to generic tailwind logo) - -# prefixClasses -PREFIXCLASSES_PREFIX=tw- # adds prefix to all tailwind classes \ No newline at end of file +LANGUAGES=html,react,vue,alpine # defaults to html +BUILDINDEX=1 # 0 | 1 \ No newline at end of file diff --git a/README.md b/README.md index 62c7bc9..0ad996e 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ ```yml name: Update on: + workflow_dispatch: # On manual trigger schedule: - cron: "0 0 * * *" # Every day at midnight @@ -25,7 +26,7 @@ - name: Checkout uses: actions/checkout@v2 - name: Run crawler - uses: gregbrimble/tailwindui-crawler-action@v1.0.0 + uses: gregbrimble/tailwindui-crawler-action@v1.1.0 with: email: ${{ secrets.TAILWINDUI_EMAIL }} password: ${{ secrets.TAILWINDUI_PASSWORD }} @@ -43,18 +44,19 @@ To be emailed whenever there is a change to a component, simply setup [GitHub No The following input options are available: -| Name | Value | Required? | Notes | -| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `email` | Your tailwindui.com account email address | Yes | | -| `password` | Your tailwindui.com account password | Yes | | -| `token` | [A GitHub Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with the `repo` scope | No | Defaults to the automatically provided [`{{ github.token }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) | -| `output` | The repository to output to
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`) | -| `commitmessage` | The message to commit with in the output repository | No | Defaults to `Update tailwindui.com` | -| `branch` | The branch to commit changes to | No | Defaults to `master` | -| `force` | `true` \| `false` | No | Defaults to `false` | -| `actor` | The GitHub user to commit changes with
e.g. `gregbrimble` | No | Defaults to the current user (`{{ github.actor }}`) | -| `repository` | The workspace repository
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`). Should contain a `.env` file in the root. | -| `crawler` | The repository of the crawler to use | No | Defaults to `kiliman/tailwindui-crawler` | -| `crawlerref` | The ref (branch, tag or SHA) to checkout of the crawler repository | No | Defaults to `master` | +| Name | Value | Required? | Notes | +| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `email` | Your tailwindui.com account email address | Yes | | +| `password` | Your tailwindui.com account password | Yes | | +| `token` | [A GitHub Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with the `repo` scope | No | Defaults to the automatically provided [`{{ github.token }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) | +| `output` | The repository to output to
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`) | +| `commitmessage` | The message to commit with in the output repository | No | Defaults to `Update tailwindui.com` | +| `current_branch` | The branch in the current repository where .env can be found | No | Defaults to `master` | +| `branch` | The branch to commit changes to | No | Defaults to `master` | +| `force` | `true` \| `false` | No | Defaults to `false` | +| `actor` | The GitHub user to commit changes with
e.g. `gregbrimble` | No | Defaults to the current user (`{{ github.actor }}`) | +| `repository` | The workspace repository
e.g. `gregbrimble/tailwindui` | No | Defaults to the current repository (`{{ github.repository }}`). Should contain a `.env` file in the root. | +| `crawler` | The repository of the crawler to use | No | Defaults to `kiliman/tailwindui-crawler` | +| `crawlerref` | The ref (branch, tag or SHA) to checkout of the crawler repository | No | Defaults to `master` | Note: If using a separate private repository for the output, you must include a Personal Access Token in the `token` input, as the `{{ github.token }}` tokens are scoped to only the current repository.