You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-7
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ A tool to audit Erlang & Elixir dependency advisories as well as retired hex pac
7
7
8
8
🚨 _**NOTE**_: security advisories are _NOT_ currently monitored for gleam dependencies. The language, while excellent, is far too new and niche
9
9
10
-
# Install
10
+
# 🔽 Install
11
11
12
12
```sh
13
13
gleam add --dev go_over
@@ -18,7 +18,7 @@ gleam add --dev go_over
18
18
- add `.go-over/` to your `.gitignore`
19
19
- make sure `git` is installed
20
20
21
-
# Usage
21
+
# ▶️ Usage
22
22
23
23
```sh
24
24
gleam run -m go_over
@@ -35,11 +35,12 @@ gleam run -m go_over
35
35
36
36
### ⚙️ Config
37
37
38
-
Optional settings that can be added to your project's gleam.toml
38
+
Optional settings that can be added to your project's `gleam.toml`
39
39
40
40
```toml
41
41
[go-over]
42
-
# disables caching if false (default: true)
42
+
# disables caching if false
43
+
# default: true
43
44
cache = true
44
45
45
46
[go-over.ignore]
@@ -65,8 +66,12 @@ ids = ["GHSA-xxxx-yyyy-zzzz"]
65
66
- As I'm sure is no surprise this tool is inspired by (and all around worse than) [mirego/mix_audit](https://github.com/mirego/mix_audit). Please check it out!
66
67
- It also draws inspiration from [mix hex.audit](https://hexdocs.pm/hex/Mix.Tasks.Hex.Audit.html)
67
68
68
-
# License
69
+
# ⚖️ License
69
70
70
-
This tool uses [mirego/elixir-security-advisories](https://github.com/mirego/elixir-security-advisories) which is it self licensed with`BSD-3-Clause license` and `CC-BY 4.0 open source license`. See their [#license section](https://github.com/mirego/elixir-security-advisories?tab=readme-ov-file#license)
71
+
-This tool uses [mirego/elixir-security-advisories](https://github.com/mirego/elixir-security-advisories) which is it self licensed with
71
72
72
-
Code original to this repo is Licensed under MIT
73
+
-`BSD-3-Clause license`
74
+
-`CC-BY 4.0 open source license`.
75
+
- See their [#license section](https://github.com/mirego/elixir-security-advisories?tab=readme-ov-file#license)
76
+
77
+
- Code original to this repo is Licensed under `MIT`
0 commit comments