From 992eff34738fdec338536143789954da2126f15d Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Mon, 23 Jul 2018 17:26:14 -0700 Subject: [PATCH] README.md: Better highlight cargo-audit and cleanup copy --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 312096b..0f68875 100644 --- a/README.md +++ b/README.md @@ -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. - Report Vulnerability + Report Vulnerability [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.