Skip to content

Commit

Permalink
docs: Add extra sentence about nvd_api_key
Browse files Browse the repository at this point in the history
For the weeks before the 3.3 release happens, add an extra sentence about the api key.

Signed-off-by: Terri Oda <terri.oda@intel.com>
  • Loading branch information
terriko committed Oct 19, 2023
1 parent 36d1e23 commit 54e7b68
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Pip will install the python requirements for you, but for some types of extracti

On first usage (and by default, once per day) The tool will download vulnerability data from [a set of known vulnerability data sources](https://github.com/intel/cve-bin-tool/blob/main/doc/MANUAL.md#data-sources). Due to reliability issues with NVD, as of release 3.3 we will be using our own NVD mirror at [https://cveb.in/](https://cveb.in/) by default rather than contact NVD directly. If you wish to get data directly from the NVD servers you must [provide your own NVD_API_KEY](https://github.com/intel/cve-bin-tool/blob/main/doc/MANUAL.md#--nvd-api-key-nvd_api_key) to use their API.

Check failure on line 76 in README.md

View workflow job for this annotation

GitHub Actions / Spell checking

`cveb` is not a recognized word. (unrecognized-spelling)

Check failure on line 76 in README.md

View workflow job for this annotation

GitHub Actions / Spell checking

`cveb` is not a recognized word. (unrecognized-spelling)

If you are using a release prior to 3.3 that does not use our mirror, please use an NVD_API_KEY as described above.

## Most popular usage options

### Finding known vulnerabilities using the binary scanner
Expand Down

0 comments on commit 54e7b68

Please sign in to comment.