📝 docs: README.md

Author: h7ml

README.md

@@ -1,46 +1,68 @@
-# Modern.js Package
+![deploy](https://github.com/dext7r/commit-comment/actions/workflows/deploy.yml/badge.svg)
+![stars](https://badgen.net/github/stars/dext7r/commit-comment)
+![forks](https://badgen.net/github/forks/dext7r/commit-comment)
+![HitCount](http://hits.dwyl.com/dext7r/commit-comment.svg)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=dext7r_commit-comment&metric=alert_status)](https://sonarcloud.io/dashboard?id=dext7r_commit-comment)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/quality_gate?project=dext7r_commit-comment)](https://sonarcloud.io/dashboard?id=dext7r_commit-comment)
+[![Bugs](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/dashboard?id=dext7r_commit-comment)
 
-## Setup
+# Commit Comment GitHub Action
 
-Install the dependencies:
+This GitHub Action allows you to automatically create a commit comment on a pull request.
 
-```bash
-pnpm run install
-```
+## Usage
 
-## Get Started
+1. Add a step in your workflow YAML file to use this action:
 
-Run and debug the module:
+   ```yaml
+   - name: Commit Comment
+     uses: dext7r/commit-comment@v1.0.0
+     with:
+       token: ${{ secrets.GITHUB_TOKEN }}
+       body: 'This is a test comment.'
+   ```
 
-```bash
-pnpm run dev
-```
+2. Configure the `token` input with a secret GitHub API token with the necessary permissions.
 
-Run test cases:
+3. Specify the `body` input with the content of the comment you want to create.
 
-```bash
-pnpm run test
-```
+## Inputs
 
-Build the module for production:
+- `token` (required): Secret GitHub API token to use for making API requests.
+- `body` (required): Comment content.
 
-```bash
-pnpm run build
-```
+## Outputs
+
+- `comment_id`: The ID of the comment that was created.
+
+## Example
 
-Enable optional features:
+```yaml
+name: Create Comment
+on:
+  pull_request:
+    types: [opened]
 
-```bash
-pnpm run new
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Commit Comment
+        uses: h7ml/commit-comment@v1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          body: 'Hello from GitHub Action!'
 ```
 
-Other commands:
+## Versioning
+
+This action follows semantic versioning. See [releases](https://github.com/h7ml/commit-comment/releases) for more information about each version.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-```bash
-pnpm run lint         # Lint and fix source files
-pnpm run change       # Add a new changeset
-pnpm run bump         # Update version and changelog via changeset
-pnpm run release      # Release the package
 ```
 
-For more information, see the [Modern.js Module documentation](https://modernjs.dev/module-tools/en).
+```