Added HISTORY.md

vehemont · Jan 21, 2022 · fe4384d · fe4384d
1 parent 4e671f0
commit fe4384d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -0,0 +1,15 @@
+Release History
+===============
+
+0.5.3 (2022-01-20)
+-------------------
+**Improvements**
+- Added rate limiting to requests to accomadate the NIST NVD recommendations. <br>
+Read more about it here: https://nvd.nist.gov/developers  
+You can get an API key for free here: https://nvd.nist.gov/developers/request-an-api-key  
+tl;dr - No API key = 10 requests per minute, or 6 seconds per request. API key = 100 requests per minute, or 0.6 seconds per request.
+- A key parameter now exists in searchCVE, getCVe, and searchCPE to allow you to include your API key.  
+```python
+>>> r = getCVE('CVE-2021-30640', key='xxxx-xxxxxx-xxxxxxxx')  
+```
+- Remade the parameter building functions to move away from kwargs** and use keyword parameters instead. This removes the requirement for `cpe_dict=False` when making a search or get.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,8 +1,3 @@
-.. NVDLib documentation master file, created by
-   sphinx-quickstart on Mon Oct 18 11:24:07 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 NVDLib: NIST National Vulnerability Database API Wrapper
 ===================================
 
@@ -79,3 +74,4 @@ Navigation:
    started
    CVE
    CPE
+   release
diff --git a/docs/source/release.rst b/docs/source/release.rst
@@ -0,0 +1,5 @@
+Updates
+===========
+
+
+Get updates on `the GitHub repo <https://github.com/Vehemont/nvdlib>`_.