Skip to content

Commit 2cdb1fa

Browse files
author
Mario Hros
committed
readme update
1 parent 056b075 commit 2cdb1fa

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@
88
A simple Golang package to convert HTML to plain text.
99

1010
It converts HTML tags to text and also parses HTML entities into characters they represent.
11-
A header section of the HTML document is stripped out, most tags are stripped but links are
12-
properly converted into their href attribute.
11+
A `<head>` section of the HTML document, as well as most other tags are stripped out but
12+
links are properly converted into their href attribute.
1313

1414
It can be used for converting HTML emails into text.
1515

1616
Some tests are installed as well.
17+
Uses semantic versioning and no breaking changes are planned.
1718

1819
Fell free to publish a pull request if you have suggestions for improvement.
1920

@@ -47,6 +48,8 @@ func main() {
4748

4849
```
4950

51+
To see all features, please look info `html2text_test.go`.
52+
5053
## Alternatives
5154
- https://github.com/jaytaylor/html2text
5255

0 commit comments

Comments
 (0)