diff --git a/README.md b/README.md index bdf041160..b63390f09 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ The next example step will deploy `./public` directory to the remote `gh-pages` publish_dir: ./public ``` +### Supported Tokens + Three tokens are supported. | Token | Private repo | Public repo | Protocol | Setup | @@ -44,6 +46,16 @@ Three tokens are supported. 1. Currently, GitHub Actions does not support to trigger a GitHub Pages build event using GITHUB_TOKEN on a public repository. +### Supported Platforms + +| runs-on | `deploy_key` | `github_token` | `personal_token` | +|---|:---:|:---:|:---:| +| ubuntu-18.04 | ✅️ | ✅️ | ✅️ | +| macos-latest | ✅️ | ✅️ | ✅️ | +| windows-latest | (2) | ✅️ | ✅️ | + +2. WIP, See [Issue #87](https://github.com/peaceiris/actions-gh-pages/issues/87) + ## Table of Contents