Improving documentation

[IciaCarroBarallobre]

Issue #36

[coveralls]

Pull Request Test Coverage Report for Build 21779289969

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 72.816%

---

Totals
Change from base Build 21779286678:	0.0%
Covered Lines:	300
Relevant Lines:	412

---

💛 - Coveralls

[maennchen]

@IciaCarroBarallobre Something's up with the smoke tests. I'm not sure if it is caused by this PR. I'll have a look.

We also need to think about what should be the official external interface of this library and what should be internal (moduledoc false). I don't think it makes sense to expose everything to the public since we might want to change the internal API without releasing a breaking change.

[maennchen]

It's working on main: https://github.com/erlef/rebar3_sbom/actions/runs/21593730375/job/62220314689

[maennchen]

@IciaCarroBarallobre The Smoke Test failure was unrelated. Fixed via aac5e79