From b98f9c9766530307f2e7b3bb7b2286938c0fe943 Mon Sep 17 00:00:00 2001
From: grantbirki <grantbirki@github.com>
Date: Thu, 13 Apr 2023 23:23:56 +0100
Subject: [PATCH] add inputs and outputs to the readme

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index e657b30..9580883 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,25 @@ jobs:
         uses: actions/deploy-pages@vX.X.X # <--- The latest version of this action
 ```
 
+## Inputs 📥
+
+| Input | Required? | Default | Description |
+| ----- | --------- | ------- | ----------- |
+| `token` | `true` | `${{ github.token }}` | The GitHub token used to create an authenticated client - Provided for you by default! |
+| `emit_telemetry` | `false` | `"false"` | Should this action only emit build telemetry instead of deploying the build artifact? |
+| `conclusion` | `false` | - | The status of the previous build |
+| `timeout` | `false` | `"600000"` | Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes) |
+| `error_count` | `false` | `"10"` | Maximum number of status report errors before cancelling a deployment (default: 10) |
+| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status report (default: 5 seconds) |
+| `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy |
+| `preview` | `false` | `"false"` | Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!) |
+
+## Outputs 📤
+
+| Output | Description |
+| ------ | ----------- |
+| `page_url` | The URL of the deployed Pages site |
+
 ## Security considerations
 
 There are a few important considerations to be aware of: