From b489072a8a7182be4d6281cbdcf02ffd0ccb7d7f Mon Sep 17 00:00:00 2001
From: bwireman <bwireman1@gmail.com>
Date: Sat, 1 Jun 2024 12:14:30 -0500
Subject: [PATCH] adds config options setting in readme

---
 README.md | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c4dd411..424f786 100644
--- a/README.md
+++ b/README.md
@@ -33,10 +33,28 @@ gleam run -m go_over
 - `--skip`: will skip checking the cache and used the stored data no matter what
 - `--force`: will force pulling new data even if the cached data is still valid
 
-### Caching
+### ⚙️ Config
+
+Optional settings that can be added to your project's gleam.toml
+
+```toml
+[go-over]
+# disables caching (default: true)
+cache = true
+
+[go-over.ignore]
+# list of package names to skip when checking for advisories & warnings (default: [])
+packages = ["example_package"]
+# list of warning severities to skip when checking for advisories & warnings (case insensitive) (default: [])
+severity = ["example_moderate"]
+# list of advisory IDs to skip when checking for advisories & warnings (default: [])
+ids = ["GHSA-xxxx-yyyy-zzzz"]
+```
+
+### ⌛ Caching
 
-- Security advisory data is cached for six hours
-- hex.pm retired package data is cached for one hour
+- Security advisory data is cached for **_six_** hours
+- hex.pm retired package data is cached for **_one_** hour
 
 # 🖌️ Other Art