From 4c0a483c95750b188c99bc57987d5132448d0722 Mon Sep 17 00:00:00 2001
From: Anne-Marie <102995847+am-stead@users.noreply.github.com>
Date: Thu, 23 May 2024 10:22:01 +0200
Subject: [PATCH] Update README.md
---
README.md | 29 ++++++++++++++++++++++-------
1 file changed, 22 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 9ae9f91..37a36dd 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,32 @@
# dependency-review-action
-This action scans your pull requests for dependency changes, and will
-raise an error if any vulnerabilities or invalid licenses are being introduced. The action is supported by an [API endpoint](https://docs.github.com/rest/dependency-graph/dependency-review) that diffs the dependencies between any two revisions on your default branch.
+- [Overview](#overview)
+- [Installation](#installation)
+- [Configuration](#configuration)
-The action is available for all public repositories, as well as private repositories that have GitHub Advanced Security licensed.
+- [Outputs](#outputs)
+- [Getting help](#getting-help)
+- [Contributing](#contributing)
+- [License](#license)
-You can see the results on the job logs:
+## Overview
-
+The dependency review action scans your pull requests for dependency changes, and will raise an error if any vulnerabilities or invalid licenses are being introduced.
+The action is supported by an [API endpoint](https://docs.github.com/en/rest/dependency-graph/dependency-review?apiVersion=2022-11-28) that diffs the dependencies between any two revisions on your default branch.
-or on the job summary:
+When the action runs, you can see the results on:
-
+- The **job logs**, found ....
+
+
+
+- The **job summary**, found ....
+
+
+
+The action is available for:
+- Public repositories
+- Private repositories with a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license.
## Installation