From 6d2900cabfb2283a2f74c463f8decfb847bf2d6f Mon Sep 17 00:00:00 2001
From: Adam Janovsky
Date: Thu, 13 Apr 2023 15:10:58 +0200
Subject: update docs

---
 docs/index.md      |  1 +
 docs/user_guide.md | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+)
 create mode 100644 docs/user_guide.md

(limited to 'docs')

diff --git a/docs/index.md b/docs/index.md
index 1baac8e6..f888917d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -32,6 +32,7 @@ Seccerts PyPi <https://pypi.org/project/sec-certs/>
 installation.md
 quickstart.md
 configuration.md
+user_guide.md
 ```
 
 ```{toctree}
diff --git a/docs/user_guide.md b/docs/user_guide.md
new file mode 100644
index 00000000..3eb8320e
--- /dev/null
+++ b/docs/user_guide.md
@@ -0,0 +1,23 @@
+# User's guide
+
+```{important}
+This guide is in the making.
+```
+
+## NVD datasets
+
+Our tool matches certificates to their possible CVEs using datasets downloaded from [National Vulnerability Database (NVD)](https://nvd.nist.gov). If you're fully processing the `CCDataset` or `FIPSDataset` by yourself, you must somehow obtain the NVD datasets.
+
+Our tool can seamlessly download the required NVD datasets when needed. We support two download mechanisms:
+
+1. Fetching datasets with the [NVD API](https://nvd.nist.gov/developers/start-here) (preferred way).
+1. Fetching snapshots from seccerts.org.
+
+The following two keys control the behaviour:
+
+```yaml
+preferred_source_nvd_datasets: "api" # set to "sec-certs" to fetch them from seccerts.org
+nvd_api_key: null # or the actual key value
+```
+
+If you aim to fetch the sources from NVD, we advise you to get an [NVD API key](https://nvd.nist.gov/developers/request-an-api-key) and set the `nvd_api_key` setting accordingly. The download from NVD will work even without API key, it will just be slow. No API key is needed when `preferred_source_nvd_datasets: "sec-certs"`
-- 
cgit v1.3.1