Skip to content

Commit 75f8917

Browse files
authored
Update README.md
1 parent d351030 commit 75f8917

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The action can check:
1111

1212
To learn how to write good alternative text, read [Alternative text for images on Primer](https://primer.style/design/guides/accessibility/alternative-text-for-images).
1313

14+
## Why you may need this action
15+
1416
Images on GitHub default to using the filename as alt text.
1517
This action flags when the alt text has not been updated from the default:
1618

@@ -52,7 +54,7 @@ jobs:
5254
uses: github/[email protected] # Set to latest
5355
```
5456
55-
### Action stability
57+
### Pin the action's version for stability
5658
5759
We recommend you pin the action to a specific version.
5860
This makes sure you stay on a stable version of this action.
@@ -66,7 +68,7 @@ Replace the ref value with any commit hash.
6668
## License
6769
6870
This project is licensed under the terms of the MIT open source license.
69-
Please refer to [the MIT license file](./LICENSE.txt) for the full terms.
71+
Please read [the MIT license file](./LICENSE.txt) for the full terms.
7072
7173
## Maintainers
7274
@@ -78,7 +80,7 @@ TODO: Be explicit about support expectations.
7880
7981
## Acknowledgement
8082
81-
Please read [Contributing Guide](./CONTRIBUTING.md) for more information.
83+
Please read our [Contributing Guide](./CONTRIBUTING.md) for more information.
8284
8385
## Contributors ✨
8486
@@ -102,4 +104,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
102104
103105
<!-- ALL-CONTRIBUTORS-LIST:END -->
104106
105-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
107+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
108+
Contributions of any kind welcome!

0 commit comments

Comments
 (0)