Skip to content

Commit 7f65185

Browse files
committed
update readme
1 parent 88146aa commit 7f65185

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A tool to audit Erlang & Elixir dependency advisories as well as retired hex pac
77

88
🚨 _**NOTE**_: security advisories are _NOT_ currently monitored for gleam dependencies. The language, while excellent, is far too new and niche
99

10-
# Install
10+
# 🔽 Install
1111

1212
```sh
1313
gleam add --dev go_over
@@ -18,7 +18,7 @@ gleam add --dev go_over
1818
- add `.go-over/` to your `.gitignore`
1919
- make sure `git` is installed
2020

21-
# Usage
21+
# ▶️ Usage
2222

2323
```sh
2424
gleam run -m go_over
@@ -35,11 +35,12 @@ gleam run -m go_over
3535

3636
### ⚙️ Config
3737

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`
3939

4040
```toml
4141
[go-over]
42-
# disables caching if false (default: true)
42+
# disables caching if false
43+
# default: true
4344
cache = true
4445

4546
[go-over.ignore]
@@ -65,8 +66,12 @@ ids = ["GHSA-xxxx-yyyy-zzzz"]
6566
- 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!
6667
- It also draws inspiration from [mix hex.audit](https://hexdocs.pm/hex/Mix.Tasks.Hex.Audit.html)
6768

68-
# License
69+
# ⚖️ License
6970

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
7172

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

Comments
 (0)