Skip to content

Commit 835194f

Browse files
feat: updated readme section (shubhaamgupta11#4)
1 parent 22c9590 commit 835194f

File tree

1 file changed

+4
-24
lines changed

1 file changed

+4
-24
lines changed

README.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -81,28 +81,8 @@ If you choose Discord as the notification method, you will need a Discord Webhoo
8181
- Create a **Discord Webhook**.
8282
- Copy the Webhook URL and add it to the GitHub secrets (`DISCORD_WEBHOOK_URL`).
8383

84-
## Inputs
84+
## Roadmap
85+
- [ ] Generalize Notification Channels: Allow adding multiple notification methods (e.g. Webhooks).
86+
- [ ] Support Custom Filters: Enable users to apply filters like labels, authors, or milestones to issues and PRs.
87+
- [ ] Handle API Rate Limiting: Add rate limiting or retry logic for handling GitHub API rate limits.
8588

86-
- `task`: The task to perform (`monitor-issues` or `monitor-prs`).
87-
- `git_token`: GitHub API token.
88-
- `slack_bot_token`: Slack Bot token.
89-
- `slack_channel`: ID of the Slack channel to send notifications.
90-
- `repo_owner`: GitHub repository owner.
91-
- `repo_name`: GitHub repository name.
92-
- `slack_id_type`: Slack ID type (`user` or `group`).
93-
- `slack_id`: Slack ID for notifications.
94-
95-
## Usage
96-
97-
```yaml
98-
- name: Run GitHub Monitor Action
99-
uses: your-repo/your-action@v1
100-
with:
101-
task: "monitor-issues"
102-
git_token: ${{ secrets.GITHUB_TOKEN }}
103-
slack_bot_token: ${{ secrets.SLACK_BOT_TOKEN }}
104-
slack_channel: ${{ secrets.SLACK_CHANNEL }}
105-
repo_owner: "my-org"
106-
repo_name: "my-repo"
107-
slack_id_type: "user"
108-
slack_id: "U01N6V7HKUJ"

0 commit comments

Comments
 (0)