diff --git a/README.md b/README.md index 15a3990..390a45a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Monitor GitHub events and clone repositories to search for secrets, and more. ## Overview -GitMon allows an operator to continually monitor the GitHub Events API to collect -metadata and look for secret leakage. +GitMon allows an operator to continually monitor the [GitHub Events API](https://docs.github.com/en/rest/activity/events) +to collect metadata and look for secret leakage. When certain events such as _CreateEvent_ or _DeleteEvent_ are observed, GitMon will send the repository URL to a worker that will clone the repository and