Skip to content

Commit

Permalink
Clarify the NIST API key documentation
Browse files Browse the repository at this point in the history
Use the same phrasing as in the warning message from #262
  • Loading branch information
oh2fih committed Jun 30, 2024
1 parent 0d1763d commit 0a965c6
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,9 @@ Or via the the CveXplore object:
>>> cvx.database.populate()
>>> cvx.database.update()
You can add your `nist api key <https://nvd.nist.gov/developers/request-an-api-key>`_ in the .env file.
You can populate CveXplore without an api key, but it will limit the amount of parallel requests made to the NIST api.
You can add your `NIST API Key <https://nvd.nist.gov/developers/request-an-api-key>`_ in the environment variable
:code:`NVD_NIST_API_KEY` (e.g., in the :code:`~/.cvexplore/.env` file). You can populate CveXplore without an API key,
but it will limit the amount of parallel requests made to the NIST API.

Package usage
-------------
Expand Down

0 comments on commit 0a965c6

Please sign in to comment.