Add README docs

#25
n1nj4t4nuk1 · Sep 28, 2023 · 9eb5a71 · 9eb5a71
1 parent b4e1f0e
commit 9eb5a71
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ A collection of Value Objects to save time by generalizing types and format vali
     * [ISO Date](#iso-date)
   * [Security value-objects](#security-value-objects)
     * [CVE](#cve)
+    * [Nullable CVE](#nullable-cve)
     * [CPE](#cpe)
 
 # Value-objects
@@ -187,6 +188,20 @@ my_cve = Cve('CVE-2014-9418')
 my_cve.value()  # returns -> 'CVE-2014-9418'
 ```
 
+### Nullable CVE
+
+```python
+from pyvalueobjects import NullableCve
+
+# Creation
+my_cve = NullableCve('CVE-2014-9418')
+my_null_cve = NullableCve(None)
+
+# Getting raw value
+my_cve.value()  # returns -> 'CVE-2014-9418'
+my_null_cve.value()  # returns -> None
+```
+
 ### CPE
 
 ```python