From a63a5b2a3f23816e80cc41fc6e82fbf8916926e0 Mon Sep 17 00:00:00 2001
From: Michael Shick <m@shick.us>
Date: Mon, 25 Nov 2019 17:03:08 -0500
Subject: [PATCH] update readme

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

diff --git a/README.md b/README.md
index e0d088b..0817ea1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
 # add-pr-comment
+
+> A GitHub Action to add a comment to a PR's associated issue
+
+## Usage
+
+```yaml
+uses: mshick/add-pr-comment@v1
+with:
+  message: |
+    **Hello!**
+    🌏
+    !
+  repo-token: ${{ secrets.GITHUB_TOKEN }}
+  allow-repeats: false
+```
+
+## Features
+
+- Fast, runs in the GitHub Actions node.js runtime; no Docker pull needed.
+- Multiple posts of the same comment optionally allowable.
+- Supports emoji 😂😂😂!