diff --git a/README.md b/README.md index 9b18908..16c238b 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ This action searches for team pings in issues and pull requests in an organizati # Input parameters -- `token`: **Require:** An access token. -- `team`: **Require:** Team name without the organization. For example: `docs-content-ecosystem` -- `org`: **Require:** The organization to search for issues.' -- `since`: The start date to search for team pings. Forma: {4 digit year}-{month}-{day}. For example: 2020-5-20'. Default: '2020-1-1' -- `project-board`: 'The URL of the project board to place issues and pull requests. Must be an org project board.' +- `token`: **Required:** An access token. +- `team`: **Required:** Name of the team whose @mentions you wannt to search for. Use the team name without the organization. For example: `docs-content-ecosystem`. +- `org`: **Required:** The organization to search for issues. +- `since`: The start date to search for team pings. Form: {4 digit year}-{month}-{day}. For example: '2020-5-20'. Default: '2020-1-1' +- `project-board`: 'The URL of the project board to place issues and pull requests. Must be an org project board. - `project-column`: The id of the column to add issues and pull requests.' -- `ignore-team`: Ignores issues and pull requests authored or commented on by members of this team. By default, the value of `team` is ignored. You can use `ignore-team` to specify a team with more members or a team that does not match the team ping being searched.' -- `ignore-repos`: Repositories to ignore when searching issues and pull requests. You can add more than one repository by using a comma-separated list. Format: {owner}/{repo}. For example: octocat/hello-world' -- `ignore-bot`: Ignores issues and pull requests authored or commented on by this bot account.' -- `comment-body`: A comment added to the issue or pull request.' +- `ignore-team`: Team whose members should respond to the `team` mentions. Issues and pull requests authored or commented on by members of this team are ignored. If you don't provide an `ignore-team`, the issues authored or commented on by members of `team` will be ignored. For example, you can use `ignore-team` to specify a team with more members than `team` or a team that includes only reviewers. +- `ignore-repos`: Repositories to ignore when searching issues and pull requests. You can add more than one repository by using a comma-separated list. Format: {owner}/{repo}. For example: octocat/hello-world +- `ignore-bot`: Ignores issues and pull requests authored or commented on by this bot account. +- `comment-body`: A comment added to the issue or pull request. ## `token`