@@ -12,6 +12,11 @@ The a11y scanner helps teams:
1212
1313---
1414
15+ ## Requirements
16+
17+ TODO: Includes a description of the kind of environment required to run the software and instructions for setting it up.
18+ It clearly states the external dependencies and directions for installing them.
19+
1520## Getting Started
1621
1722### 1. Add a Workflow File
@@ -27,11 +32,10 @@ jobs:
2732 runs-on : ubuntu-latest
2833 steps :
2934 # Retrieve the scanner code
30- - uses : actions/checkout@v5
35+ - uses : github-community-projects/continuous-ai-for-accessibility-scanner@v2
3136 with :
3237 repository : github-community-projects/continuous-ai-for-accessibility-scanner
3338 ref : v1
34- token : ${{ secrets.GH_COMMUNITY_PROJECTS_TOKEN }} # This token must have read access to github-community-projects/continuous-ai-for-accessibility-scanner; more information below.
3539 path : ./.github/actions/continuous-ai-for-accessibility-scanner
3640 # Prepare the scanner to run
3741 - shell : bash
@@ -56,15 +60,9 @@ Required Permissions:
5660
5761---
5862
59- # ## 2. Create Tokens and Add Secrets
63+ # ## 2. Create a Token and Add a Secret
6064
61- The a11y scanner requires two Personal Access Tokens (PATs) as repository secrets :
62-
63- # ### The `GH_COMMUNITY_PROJECTS_TOKEN` is a fine-grained PAT with
64-
65- - `contents : read`
66- - `metadata : read`
67- - Scope : [`github-community-projects/continuous-ai-for-accessibility-scanner`](https://github.com/github-community-projects/continuous-ai-for-accessibility-scanner)
65+ The a11y scanner requires a Personal Access Token (PAT) as repository secret :
6866
6967# ### The `GH_TOKEN` is a fine-grained PAT with
7068
@@ -129,8 +127,24 @@ The a11y scanner leverages Copilot coding agent, which can be configured with cu
129127
130128# # Feedback
131129
132- Beta participants have direct contact for questions and suggestions. A public feedback form will be available once the project is open-sourced.
130+ Please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file for more information.
131+
132+ # # License
133+
134+ This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
135+
136+ # # Maintainers
137+
138+ TODO : Enter at least one maintainer in here or point to codeowners file.
139+
140+ # # Support
141+
142+ Please refer to the [SUPPORT](./SUPPORT.md) file for more information.
143+
144+ # # Acknowledgement
145+
146+ TODO : Thank you to our beta testers for their help in testing this project.
133147
134148---
135149
136- *Last updated: 2025-10-01 *
150+ *Last updated: 2025-10-09 *
0 commit comments