Skip to content

Commit 9eb5a71

Browse files
committed
Add README docs
#25
1 parent b4e1f0e commit 9eb5a71

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ A collection of Value Objects to save time by generalizing types and format vali
2727
* [ISO Date](#iso-date)
2828
* [Security value-objects](#security-value-objects)
2929
* [CVE](#cve)
30+
* [Nullable CVE](#nullable-cve)
3031
* [CPE](#cpe)
3132

3233
# Value-objects
@@ -187,6 +188,20 @@ my_cve = Cve('CVE-2014-9418')
187188
my_cve.value() # returns -> 'CVE-2014-9418'
188189
```
189190

191+
### Nullable CVE
192+
193+
```python
194+
from pyvalueobjects import NullableCve
195+
196+
# Creation
197+
my_cve = NullableCve('CVE-2014-9418')
198+
my_null_cve = NullableCve(None)
199+
200+
# Getting raw value
201+
my_cve.value() # returns -> 'CVE-2014-9418'
202+
my_null_cve.value() # returns -> None
203+
```
204+
190205
### CPE
191206

192207
```python

0 commit comments

Comments
 (0)