x/vulndb: update report format doc to reflect new changes and improve readability

Documentation for the vulndb reports now reflects refactored Package and
adds documentation for GHSA IDs.

Additionally reformats document for readability, adds more examples, and
makes wording more consistent throughout.

Change-Id: I64798238ac3f1476c64691bdbcefa15d8de8e375
Reviewed-on: https://go-review.googlesource.com/c/vulndb/+/406254
Reviewed-by: Tatiana Bradley <tatiana@golang.org>
Reviewed-by: Damien Neil <dneil@google.com>
Reviewed-by: Julie Qiu <julie@golang.org>
2 files changed
tree: 74e37c8fa6093d195dc8b7e286fb89d4b2964903
  1. .github/
  2. cmd/
  3. deploy/
  4. devtools/
  5. doc/
  6. internal/
  7. reports/
  8. terraform/
  9. .gitignore
  10. all_test.go
  11. AUTHORS
  12. checks.bash
  13. CONTRIBUTING.md
  14. CONTRIBUTORS
  15. go.mod
  16. go.sum
  17. LICENSE
  18. PATENTS
  19. README.md
  20. tools_test.go
README.md

The Go Vulnerability Database

This repository contains the reports for the Go Vulnerability Database.

If you are interested accessing data from the Go Vulnerability Database, see x/vuln for information. This repository is only used for adding new vulnerabilities.

Reporting a vulnerability

We are not accepting new vulnerability reports at this time. We will update this README.md once we are ready to receive reports.

License

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.

Database entries are distributed under the terms of the CC-BY 4.0 license. See x/vuln for information on how to access these entries.