From a611fa6e54ada9d5dfd62f67bed9ab9b370b09fb Mon Sep 17 00:00:00 2001
From: nirsky <nir@aspecto.io>
Date: Mon, 1 Mar 2021 17:18:10 +0200
Subject: [PATCH] updated readme

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 76440b0..3d25b5f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# enable-pr-automerge-action
\ No newline at end of file
+# enable-pr-automerge-action
+## What does this action do?
+Enable auto-merge on a pull request in any repo from any CI
+
+## Inputs
+### `token`
+Github token to perform the action with.
+### `owner`
+Organization/user which owns the repo.
+
+### `repo`
+repo name.
+### `pull-number`
+Pull request number.
+
+### `merge-method` (optional)
+One of "SQUASH", "MERGE" or "REBASE". Default is "SQUASH".
+## Example Usage
+
+```yaml
+  - name: Enable automerge on a repository
+    uses: aspecto-io/enable-pr-automerge-action@master
+    with:
+        token: ${{ secrets.MY_GITHUB_TOKEN }}
+        owner: 'my-org'
+        repo: 'my-repo'
+        pull-number: '102'
+        merge-method: 'SQUASH'
+```
\ No newline at end of file