OMGeeky/advisory-db
1
0
Fork 0
mirror of https://github.com/OMGeeky/advisory-db.git synced 2026-02-23 15:38:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #45 from RustSec/readme-cleanups

Browse Source 
README.md: Better highlight cargo-audit and cleanup copy
This commit is contained in:
Tony Arcieri
2018-07-23 17:31:28 -07:00
committed by GitHub
parent 278cd5b7ce 992eff3473
commit ad30725335
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -13,16 +13,21 @@
The RustSec Advisory Database is a repository of security advisories filed
against Rust crates published via https://crates.io
Advisory metadata is stored in [TOML] format for [cargo-audit] and other
automated tools to consume.
Advisory metadata is stored in [TOML] format (see below). The following tools
consume the data and can be used for auditing and reporing (send PRs to add yours):
* [cargo-audit]: Audit `Cargo.lock` files for crates with security vulnerabilities
[TOML]: https://github.com/toml-lang/toml
[cargo-audit]: https://github.com/rustsec/cargo-audit
## Reporting Vulnerabilities
Vulneraties can be reported by opening pull requests using the template
below. See [CONTRIBUTING.md] for more information.
To report a new vulnerability, open a pull request using the template below.
See [CONTRIBUTING.md] for more information.
<a href="https://github.com/RustSec/advisory-db/blob/master/CONTRIBUTING.md">
<img alt="Report Vulnerability" width="250px" height="60px" src="https://rustsec.org/assets/img/report-vuln-button.png">
<img alt="Report Vulnerability" width="250px" height="60px" src="https://rustsec.org/assets/img/report-vuln-button.svg">
</a>
[CONTRIBUTING.md]: https://github.com/RustSec/advisory-db/blob/master/CONTRIBUTING.md
@@ -69,9 +74,6 @@ The flaw was corrected by Z.
"""
```
[TOML]: https://github.com/toml-lang/toml
[cargo-audit]: https://github.com/rustsec/cargo-audit
## License
All content in this repository is placed in the public domain.