Skip to content

Commit aa9079b

Browse files
committed
Add Docs at readme
Close #27
1 parent debbea7 commit aa9079b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ A collection of Value Objects to save time by generalizing types and format vali
2929
* [CVE](#cve)
3030
* [Nullable CVE](#nullable-cve)
3131
* [CPE](#cpe)
32+
* [Nullable CPE](#nullable-cpe)
3233

3334
# Value-objects
3435

@@ -212,4 +213,18 @@ my_cpe = Cpe('cpe:/a:openjdk:openjdk:8u282')
212213

213214
# Getting raw value
214215
my_cpe.value() # returns -> 'cpe:/a:openjdk:openjdk:8u282'
216+
```
217+
218+
### Nullable CPE
219+
220+
```python
221+
from pyvalueobjects import NullableCpe
222+
223+
# Creation
224+
my_cpe = NullableCpe('cpe:/a:openjdk:openjdk:8u282')
225+
my_null_cpe = NullableCpe(None)
226+
227+
# Getting raw value
228+
my_cpe.value() # returns -> 'cpe:/a:openjdk:openjdk:8u282'
229+
my_null_cpe.value() # returns -> None
215230
```

0 commit comments

Comments
 (0)