Merge pull request #1 from github/kendallgassner-patch-1

Update README.md

Author: kendallgassner

.github/workflows/test-accessibility-alt-text-bot.yml

@@ -14,10 +14,4 @@ jobs:
     if: ${{ github.event.issue || github.event.pull_request && github.event.comment.user.login != 'accessibility-bot' }}
     steps:
       - name: Get private action 'github/accessibility-alt-text-bot'
-        uses: actions/checkout@v2
-        with:
-          repository: github/accessibility-alt-text-bot
-          token: ${{ secrets.GH_TOKEN }}
-          path: ./.github/actions/github/accessibility-alt-text-bot
-      - name: Check alt text
         uses: ./.github/actions/github/accessibility-alt-text-bot

README.md

@@ -6,16 +6,6 @@ An action to remind users to add alt text to their issue descriptions and commen
 
 Copy this workflow into any repo you want the Accessibility-alt-text-bot to run in.
 
-## Action stability
-
-To ensure you stay on a stable version of this action consider locking the action to a specific version.
-
-```       
-       uses: github/accessibility-alt-text-bot@4a94d0359143b44dab2e392616a02f88c30329df
-```    
-
-Replace the ref value with any commit hash.
-
 ```
 name: Test Accessibility-alt-text-bot
 on: 
@@ -36,10 +26,15 @@ jobs:
         uses: github/accessibility-alt-text-bot
 ```
 
-## Future work
+## Action stability
+
+To ensure you stay on a stable version of this action consider locking the action to a specific version.
 
-Due to time restraints this action does not have any tests. An easy way to test this would be to move the bash script in `action.yml` to its own file and create test cases with mock comments.
+```       
+       uses: github/accessibility-alt-text-bot@4a94d0359143b44dab2e392616a02f88c30329df
+```    
 
+Replace the ref value with any commit hash.
 
 ## License 
 
@@ -56,4 +51,4 @@ TODO: Be explicit about support expectations.
 
 ## Acknowledgement
 
-Please read [Contributing Guide](./CONTRIBUTING.md) for more information.
+Please read [Contributing Guide](./CONTRIBUTING.md) for more information.