diff --git a/github-deploystatus/README.md b/github-deploystatus/README.md
new file mode 100644
index 0000000..6c0966f
--- /dev/null
+++ b/github-deploystatus/README.md
@@ -0,0 +1,22 @@
+# github-deploystatus
+
+This action makes it easier to report back deploy status to github.
+
+## Usage 
+
+```
+- name: Report success
+  uses: unacast/actions/github-status@v0.9.0
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  with:
+    state: success
+
+- name: Report fail
+  uses: unacast/actions/github-status@v0.9.0
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  with:
+    state: failure
+  if: failure()
+```