docs: Update documentation

README.md

@@ -1 +1,28 @@
-# detect-changes-action
+# detect-changes-action
+
+## Description
+
+Action to get paths and files changed in a Pull Request event and use these for [GitHub Actions matrix](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs)
+
+## Inputs
+
+| parameter | description | required | default |
+| - | - | - | - |
+| path | Path | `false` | ./ |
+| token | The token to use to access the GitHub API | `false` | ${{ github.token }} |
+
+
+## Outputs
+
+| parameter | description |
+| - | - |
+| paths_changed | List of changed paths, example: ``` ["dist", "dist/data"] ```
+ |
+| file_changed | List of changed files, example: ``` ["dist/main.tf", "dist/index.js"] ```
+ |
+
+
+## Runs
+
+This action is a `node16` action.
+

action.yml

@@ -1,5 +1,5 @@
-name: 'PR Metadata Action'
-description: 'Adds pull request file changes as a comment to a newly opened PR'
+name: 'Detect PR changes'
+description: 'Action to get paths and files changed in a Pull Request event and use these for [GitHub Actions matrix](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs)'
 inputs:
   path:
     description: 'Path'
@@ -9,6 +9,19 @@ inputs:
     description: 'The token to use to access the GitHub API'
     required: false
     default: ${{ github.token }}
+outputs:
+  paths_changed:
+    description: >
+      List of changed paths, example:
+      ```
+      ["dist", "dist/data"]
+      ```
+  file_changed:
+    description: >
+      List of changed files, example:
+      ```
+      ["dist/main.tf", "dist/index.js"]
+      ```
 runs:
   using: 'node16'
   main: 'dist/index.js'