Merge pull request #10 from Akkjon/update-readme-with-badge

Update README.md

README.md

@@ -2,6 +2,8 @@
 A Github action to remove a milestone by the milestone's name
 [Code of conduct](CODE_OF_CONDUCT.md)
 
+[![GitHub release](https://img.shields.io/github/tag/Akkjon/close-milestone.svg)](https://gitHub.com/Akkjon/close-milestone/releases/)
+
 ## Inputs
 ### `milestone_name`
 **Required** The name of the milestone, to close.
@@ -16,13 +18,13 @@ Default: false
 The id of the milestone which has been closed.
 
 ## Explanation for usage
-- The `uses` keyword specifies which action us used. `Akkjon/close-milestone` specifies which repository is used, the `@v2.0.2` defines which version of the action is used. To always use the latest version, you can change it to `@master`, but please be aware that changes in the action might break your workflow.
+- The `uses` keyword specifies which action us used. `Akkjon/close-milestone` specifies which repository is used, the `@<tag>` defines which version of the action is used. You can find the latest version in the badge at the top of the readme file. To always use the latest version, you can change it to `@master`, but please be aware that changes in the action might break your workflow.
 - The `env`keyword specifies the environment variables used by and provided to the action. `GITHUB_TOKEN` is the secret access token to authorize to the used repository. Without this keyword, the action would not be able to login and close the milestone. It is not stored in any way or transmitted. As the code is open source, it would be noticed anyways.
 - the `with` keyword specifies data you have to specify. Here the input variables are defined. These are specified [above](#inputs) 
 
 ## Example minimal usage
 ```yaml
-uses: Akkjon/close-milestone@v2.0.2
+uses: Akkjon/close-milestone@<tag>
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
@@ -31,10 +33,10 @@ with:
 
 ## Example usage with crash on missing
 ```yaml
-uses: Akkjon/close-milestone@v2.0.2
+uses: Akkjon/close-milestone@<tag>
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
   milestone_name: milestoneName
   crash_on_missing: true
-```
+```