From 3ae540bf961aaa42cbb834a72c5b04f90e21273c Mon Sep 17 00:00:00 2001
From: Federico Builes <febuiles@github.com>
Date: Wed, 1 Jun 2022 13:39:05 +0200
Subject: [PATCH] Updating the README with config instructions.

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3501db3..e68f294 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,34 @@ jobs:
         uses: actions/dependency-review-action@v1
 ```
 
-Please keep in mind that you need a GitHub Advanced Security license if you're running this Action on private repos.
+Please keep in mind that you need a GitHub Advanced Security license
+if you're running this Action on private repos.
+
+## Configuration
+
+The Dependency Review Action uses a YAML configuration file. It
+expects this file to be named `dependency-review.yml`, inside your
+`.github/` directory.
+
+Here's a sample configuration file:
+
+```yaml
+fail_on_severity: low
+```
+
+[Here](https://github.com/actions/dependency-review-action/blob/main/.github/dependency-review.yml)
+you can see an example of the configuration file we use for this repository.
+
+### Severity
+
+By default this Action blocks any pull request that contains a
+vulnerability of any severity level. You can override this behavior by
+setting an option in your configuration file:
+
+```yaml
+# choose one of: 'critical', 'high', 'moderate' or 'low'
+fail_on_severity: high
+```
 
 ## Getting help