Skip to content

Commit 83869ac

Browse files
committed
Update README to provide more details on how this action works.
1 parent dbbedcf commit 83869ac

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# Accessibility-alt-text-bot
22

3-
An action to remind users to add alt text to their issue descriptions and comments.
3+
This action supports accessible content sharing on GitHub by leaving an automated reminder whenever an image is shared on a GitHub Issue or Pull request without meaningful alternative text (alt text).
4+
Alternative text helps convey the context of the image to those who use assistive technologies such as a screen reader and removes accessibility barriers.
5+
6+
For guidance on setting alternative text, see [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images).
7+
8+
Images on GitHub default to using the filename as alt text. This action flags when the alt text has not been updated from the default.
9+
10+
**Note**: Ordinarily, setting `alt=""` will mark images as decorative. However, GitHub currently renders all images as a link. To avoid rendering links with no names, we recommend always setting alt text on images in GitHub.
411

512
## How to add this action to your repo
613

714
Copy this workflow into any repo you want the accessibility-alt-text-bot to run in.
815

9-
```
16+
```yml
1017
name: Accessibility-alt-text-bot
1118
on:
1219
issues:
@@ -26,22 +33,21 @@ jobs:
2633
uses: github/accessibility-alt-text-bot
2734
```
2835
29-
## Action stability
36+
### Action stability
3037
3138
To ensure you stay on a stable version of this action consider locking the action to a specific version.
3239
33-
```
40+
```yml
3441
uses: github/[email protected]
35-
```
42+
```
3643
3744
Replace the ref value with any commit hash.
3845
39-
## License
46+
## License
4047
4148
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.
4249
43-
44-
## Maintainers
50+
## Maintainers
4551
4652
See [CODEOWNERS](.github/CODEOWNERS).
4753

0 commit comments

Comments
 (0)