Skip to content

Commit feb0afb

Browse files
committed
Add codecov badge to README
1 parent fb5c714 commit feb0afb

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
55
![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)
66
![Apache 2](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)
7+
[![codecov](https://codecov.io/gh/IBM-Swift/swift-html-entities/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM-Swift/swift-html-entities)
78

89
## Summary
910
Pure Swift HTML encode/decode utility tool for Swift 3.
@@ -161,7 +162,9 @@ print(html.htmlEscape(useNamedReferences: false))
161162

162163
#### `strict`
163164

164-
Defaults to `false`. Specifies if HTML5 parse errors should be thrown or simply passed over. **NOTE**: `htmlUnescape()` is a throwing function if `strict` is used in call argument (no matter if it is set to `true` or `false`); `htmlUnescape()` is NOT a throwing function if no argument is provided.
165+
Defaults to `false`. Specifies if HTML5 parse errors should be thrown or simply passed over.
166+
167+
**Note**: `htmlUnescape()` is a throwing function if `strict` is used in call argument (no matter if it is set to `true` or `false`); `htmlUnescape()` is NOT a throwing function if no argument is provided.
165168

166169
```swift
167170
import HTMLEntities

0 commit comments

Comments
 (0)