Skip to content

Commit

Permalink
adds config options setting in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bwireman committed Jun 1, 2024
1 parent 4ecdb4f commit b489072
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b489072

Please sign in to comment.