Skip to content

Commit 2964b4b

Browse files
authored
Update README.md
Updated README
1 parent 4a31de2 commit 2964b4b

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The a11y scanner helps teams:
88
- 📝 Create actionable GitHub issues that can be assigned to Copilot
99
- 🤖 Propose fixes with Copilot, with humans reviewing before merging
1010

11-
> ⚠️ The a11y scanner is currently in beta. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging.
11+
> ⚠️ **Note:** The a11y scanner is currently in beta. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging!
1212
1313
---
1414

@@ -44,7 +44,7 @@ jobs:
4444
token: ${{ secrets.GH_TOKEN }} # This token must have write access to the repo above (contents, issues, and PRs); more information below. Note: GitHub Actions’ `GITHUB_TOKEN` (https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) cannot be used here.
4545
```
4646
47-
> Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for more details.
47+
> 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
4848

4949
Required Permissions:
5050
- Write access to add or update workflows
@@ -70,19 +70,15 @@ The a11y scanner requires two Personal Access Tokens (PATs) as repository secret
7070
- `metadata: read`
7171
- Scope: Your target repository (where issues and PRs will be created)
7272

73-
> GitHub Actions' default `GITHUB_TOKEN` cannot be used here.
73+
> 👉 GitHub Actions' default `GITHUB_TOKEN` cannot be used here.
7474

7575
📚 [Creating a fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) | [Creating repository secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository)
7676

7777
---
7878

7979
### 3. Run Your First Scan
8080

81-
Trigger the workflow, either manually or automatically based on your configuration. The a11y scanner will:
82-
83-
- 🔎 Analyze your target URLs, files, or repos
84-
- 📝 File issues for accessibility findings
85-
- 🤖 Optionally assign issues to Copilot to create PRs with proposed fixes
81+
Trigger the workflow manually or automatically based on your configuration. The scanner will run and create issues for any accessibility findings. When issues are assigned to Copilot, always review proposed fixes before merging.
8682

8783
📚 [Running a workflow manually](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow#running-a-workflow)
8884

0 commit comments

Comments
 (0)