Skip to content

Commit 802a588

Browse files
Update README.md
1 parent f303522 commit 802a588

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Managing activity in open-source repositories can be challenging. With a constan
66

77
This [GitHub Action](https://github.com/marketplace/actions/repo-monitor) empowers open-source maintainers by:
88

9-
- Tracking new issues and pull requests in real-time.
9+
- Tracking new issues and pull requests.
1010
- Sending auto-generated notifications to **Slack** or **Discord**.
1111
- Customizing Slack notifications with the ability to ping specific users or groups.
1212
- Allowing Slack notifications to be sent to designated channels.
1313

14-
With **Repo Activity Monitor**, you can stay on top of your repositories' activities, streamline communication, and ensure no critical issues or pull requests fall through the cracks.
14+
With **Repo Activity Monitor**, you can stay on top of your repositories activities, streamline communication, and ensure no critical issues or pull requests fall through the cracks.
1515

1616
## Usage
1717

@@ -84,16 +84,16 @@ jobs:
8484
discord_webhook_url: "${{ secrets.DISCORD_WEBHOOK_URL }}"
8585
```
8686
87-
> **Note:** You can configure any notifier (slack, discord, or others) for any task (monitor-issues, monitor-prs, etc.).
87+
> **Note:** You can configure any notifier (slack, discord) for any task (monitor-issues, monitor-prs, etc.).
8888
8989
## 🔧 Inputs
9090
9191
| Input | Description | Required | Default |
9292
| ----- | ----------- | -------- | ------- |
9393
| task | The task to run (monitor-issues or monitor-prs). | Yes | None |
9494
| git_secret | GitHub token for authentication. | Yes | None |
95-
| repo_owner | The owner of the GitHub repository (`facebook`). | Yes | None |
96-
| repo_name | The name of the GitHub repository (`react-native`). | Yes | None |
95+
| repo_owner | The owner of the GitHub repository (`user-name`). | Yes | None |
96+
| repo_name | The name of the GitHub repository (`repo-name`). | Yes | None |
9797
| fetch_data_interval | The time interval to fetch data for (e.g., 1 hour, 24 hours). This should align with the cron schedule. | Yes | None |
9898
| notifier | Notification method (**slack** or **discord**). | Yes | None |
9999
| slack_bot_token | Slack bot token to send notifications (required if notifier=`slack`). | No | None |
@@ -129,7 +129,7 @@ jobs:
129129

130130
## 🔮 Roadmap
131131

132-
- [ ] **Generalize Notification Channels**: Allow adding multiple notification methods (e.g. Webhooks).
132+
- [ ] **Generalize Notification Channels**: Allow adding multiple notification methods (e.g. Webhooks, MS Teams).
133133
- [ ] **Support Custom Filters**: Enable users to apply filters like labels, authors, or milestones to issues and PRs.
134134
- [ ] **Handle API Rate Limiting**: Add rate limiting or retry logic for handling GitHub API rate limits.
135135
- [ ] **Track inactivity** on issues and notify users after a specific TAT (Turnaround Time).

0 commit comments

Comments
 (0)