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 😂😂😂!