Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joobert committed Jun 14, 2024
1 parent b05489e commit c7c831b
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,11 @@

**Mitten** is a Python script designed to monitor GitHub repositories for new commits and send notifications to a specified Discord channel. The script leverages the GitHub API to fetch commit information and Discord Webhooks to post notifications.

# Known Issues
- Enabling multithreading may cause issues with larger repositories due to async, causing previously logged commits to be spammed. Enable at your discretion.

## Features

- Fetches commits from specified GitHub repositories.
- Sends commit notifications to Discord with detailed commit information.
- Supports multiple repositories concurrently using threading. (Off by default due to async problems with larger repositories)
- Supports multiple repositories concurrently using threading. (Toggleable in the script's main function, turn this off if you are having issues with notifications or rate limiting.)
- Logs commit information locally to avoid duplicate notifications.
- Fetches commits pushed since the last runtime of the script, ensuring that commits pushed during downtime are still fetched in the next run.
- Configurable through environment variables.
Expand Down

0 comments on commit c7c831b

Please sign in to comment.