Added more info to the readme

README.md

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: OpenCover Badge Generator
-        uses: danpetitt/[email protected].3
+        uses: danpetitt/[email protected].6
         with:
           path-to-opencover-xml: ./test/opencover.xml
           path-to-badges: ./
@@ -34,3 +34,21 @@ Once generated you will get two badges called `coverage-badge-line.svg` and `cov
 ```markdown
 [![Coverage Status](./coverage-badge-line.svg)](https://github.com/danpetitt/open-cover-badge-generator-action/)
 ```
+
+## Inputs
+
+### `path-to-opencover-xml`
+
+**Required** Path to the open cover xml file
+
+### `path-to-badges`
+
+**Optional** Path where the line and branch coverage svgs would be saved; these will be saved with the names coverage-badge-line.svg and coverage-badge-branch.svg; if not specified the files will be saved into the project root. Default `"./"`.
+
+### `minimum-coverage`
+
+**Required** Threshold percentage at which a red badge would appear.
+
+### `repo-token`
+
+**Required** GitHub repo token so that the changed file can be committed, like `${{ secrets.CI_TOKEN }}`

action.yml

@@ -3,10 +3,10 @@ description: 'Reads an open cover xml file and generates a badge to use in readm
 author: 'Dan Petitt (Coderanger.com)'
 inputs:
   path-to-opencover-xml:
-    description: 'Set the path to the open cover xml file'
+    description: 'Path to the open cover xml file'
     required: true
   path-to-badges:
-    description: 'Set the path where the line and branch coverage svgs would be saved; these will be saved with the names coverage-badge-line.svg and coverage-badge-branch.svg; if not specified the files will be saved into the project root'
+    description: 'Path where the line and branch coverage svgs would be saved; these will be saved with the names coverage-badge-line.svg and coverage-badge-branch.svg; if not specified the files will be saved into the project root'
     required: false
   minimum-coverage:
     description: 'Threshold percentage at which a red badge would appear'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-cover-badge-generator-action",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "GitHub Action to read an open cover xml file in the project folder and generate a badge to use in readme file",
   "main": "src/index.js",
   "repository": {