Merge pull request #1 from luisgj/chore/readme

Update README.md

README.md

@@ -1,2 +1,28 @@
-# group-pull-requests
-A Javascript Github Action that fetches open pull requests with a specific tag and returns the grouped source branches.
+# Group Pull Requests Github Action
+
+A Javascript Github Action that fetches open pull requests with a specific label and returns the grouped source branches.
+
+## Inputs
+
+### `detect-label`
+
+**Required** The label that all Pull Requests must contain to be grouped.
+
+### `repo-token`
+
+**Required** The token secret stored in `secrets.GITHUB_TOKEN`
+
+## Outputs
+
+### `branches`
+
+Grouped list of open branches with the same tag
+
+## Example usage
+
+```yaml
+uses: luisgj/[email protected]
+with:
+  detect-label: 'stage-ready'
+  repo-token: '${{ secrets.GITHUB_TOKEN }}'
+```