Convert action to TypeScript

README.md

@@ -1,6 +1,18 @@
 # First Interaction
 
-An action for filtering pull requests and issues from first-time contributors.
+[![Super-Linter](https://github.com/actions/first-interaction/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
+![CI](https://github.com/actions/first-interaction/actions/workflows/ci.yml/badge.svg)
+[![Check dist/](https://github.com/actions/first-interaction/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/first-interaction/actions/workflows/check-dist.yml)
+[![CodeQL](https://github.com/actions/first-interaction/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/first-interaction/actions/workflows/codeql-analysis.yml)
+[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
+
+An action for filtering pull requests (PRs) and issues from first-time
+contributors.
+
+When a first-time contributor opens a PR or issue, this action will add a
+comment to the PR or issue with a message of your choice. This action is useful
+for welcoming first-time contributors to your project and providing them with
+information about how to contribute effectively.
 
 ## Usage
 
@@ -9,23 +21,32 @@ See [action.yml](action.yml)
 ```yaml
 name: Greetings
 
-on: [pull_request, issues]
+on:
+  pull_request:
+    types:
+      - opened
+  issues:
+    types:
+      - opened
+
+permissions:
+  issues: write
+  pull-requests: write
 
 jobs:
   greeting:
+    name: Greet First-Time Contributors
     runs-on: ubuntu-latest
+
     steps:
-    - uses: actions/first-interaction@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        issue-message: |
-          # Message with markdown.
-          This is the message that will be displayed on users' first issue.
-        pr-message: |
-          Message that will be displayed on users' first pr.
-          Look, a `code block` for markdown.
+      - uses: actions/first-interaction@vX.Y.Z # Set this to the latest release
+        with:
+          issue-message: |
+            # Issue Message with Markdown
+
+            This is the message that will be displayed!
+          pr-message: |
+            # PR Message with Markdown
+
+            This is the message that will be displayed!
 ```
-
-## License
-
-The scripts and documentation in this project are released under the [MIT License](LICENSE)