From c3f81dc6e7938e70e9b9abe8fd501668b43f143a Mon Sep 17 00:00:00 2001 From: Esa Jokinen <58781154+oh2fih@users.noreply.github.com> Date: Sun, 30 Jun 2024 20:02:01 +0300 Subject: [PATCH] Clarify the NIST API key documentation (#296) --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c8dbd8885..01ff06326 100644 --- a/README.rst +++ b/README.rst @@ -107,8 +107,9 @@ Or via the the CveXplore object: >>> cvx.database.populate() >>> cvx.database.update() -You can add your `nist 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 `_ 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 -------------