From eecc0ae40c4e516babd45dc91a6187236de2e50e Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Thu, 26 Oct 2023 00:25:53 +0100 Subject: [PATCH] Update README --- .cookiecutter/includes/README/head.md | 6 ++++-- README.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.cookiecutter/includes/README/head.md b/.cookiecutter/includes/README/head.md index 7da0881..5e34360 100644 --- a/.cookiecutter/includes/README/head.md +++ b/.cookiecutter/includes/README/head.md @@ -1,10 +1,12 @@ `dependabot-alerts` lists Dependabot security alerts for all repos of a GitHub -user or organization. You can run it from the command line: +organization. You can run it from the command line: ```terminal -$ dependabot-alerts +$ dependabot-alerts ``` +You'll need to have [GitHub CLI](https://cli.github.com/) installed and logged in. + There's also a [GitHub Actions workflow](.github/workflows/alert.yml) that runs automatically on a schedule and notifies us in Slack of any Dependabot alerts in the `hypothesis` GitHub organization. diff --git a/README.md b/README.md index acf29d0..ebabf3c 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,14 @@ Notifications of Dependabot alerts across a GitHub organization. `dependabot-alerts` lists Dependabot security alerts for all repos of a GitHub -user or organization. You can run it from the command line: +organization. You can run it from the command line: ```terminal -$ dependabot-alerts +$ dependabot-alerts ``` +You'll need to have [GitHub CLI](https://cli.github.com/) installed and logged in. + There's also a [GitHub Actions workflow](.github/workflows/alert.yml) that runs automatically on a schedule and notifies us in Slack of any Dependabot alerts in the `hypothesis` GitHub organization.