diff --git a/README.md b/README.md index 86841eb..e864f54 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # actions/add-to-project -Use this action to automatically add the current issue or pull request to a GitHub Project. -Note that this is for [GitHub Projects +Use this action to automatically add the current issue or pull request to a GitHub project. +Note that this is for [GitHub projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects), -not the original GitHub Projects. +not the original GitHub projects. ## Current Status @@ -53,7 +53,7 @@ jobs: ## Inputs -- `project-url` **(required)** is the URL of the GitHub Project to add issues to. +- `project-url` **(required)** is the URL of the GitHub project to add issues to. _eg: `https://github.com/orgs|users//projects/`_ - `github-token` **(required)** is a [personal access token](https://github.com/settings/tokens/new) with the `repo`, `write:org` and @@ -64,7 +64,7 @@ jobs: ## Supported Events -> **NOTE:** This Action (currently) only supports auto-adding Issues to a Project which lives in the same organization as your target repo. +> **NOTE:** This Action (currently) only supports auto-adding Issues to a project which lives in the same organization as your target repo. Currently this action supports the following [`issues` events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues):