diff --git a/README.md b/README.md index a901f28..a66b73b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Create a `workflow.yml` file in your `.github/workflows` directory like: uses: "alstr/todo-to-issue-action@v4.0.7" id: "todo" with: - TOKEN: ${{ secrets.GITHUB_TOKEN }} + TOKEN: ${{ secrets.GITHUB_TOKEN }} // defaults to ${{ github.token }} ``` See [Github's workflow syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions) for further details on this file. @@ -49,7 +49,7 @@ The workflow file takes the following inputs: | Input | Required | Description | |----------|----------|-------------| -| `TOKEN` | Yes | The GitHub access token to allow us to retrieve, create and update issues for your repo. This should be set to `${{ secrets.GITHUB_TOKEN }}`. | +| `TOKEN` | No | The GitHub access token to allow us to retrieve, create and update issues for your repo. Default: `${{ github.token }}` | | `CLOSE_ISSUES` | No | Optional boolean input that specifies whether to attempt to close an issue when a TODO is removed. Default: `true`. | | `AUTO_P` | No | Optional boolean input that specifies whether to format each line in multiline TODOs as a new paragraph. Default: `true`. |