README -> markdown

This commit is contained in:
alex wennerberg
2022-04-23 21:49:21 -07:00
parent 10c2a0cbff
commit 77989212d3

View File

@@ -2,25 +2,22 @@ nanohtml2text
============= =============
0-dependency library to convert HTML to text; an alternative to 0-dependency library to convert HTML to text; an alternative to
https://crates.io/crates/html2text that doesn't use a full browser-grade HTML [html2text](https://crates.io/crates/html2text) that doesn't use a full
parser browser-grade HTML parser
Based on https://github.com/k3a/html2text Based on [this go html2text library](https://github.com/k3a/html2text)
Primarily useful for displaying HTML emails as text. YMMV depending on the Primarily useful for displaying HTML emails as text. YMMV depending on the
structure of the HTML you're trying to convert. Built for the needs of structure of the HTML you're trying to convert.
Crabmail: https://git.alexwennerberg.com/crabmail/
This library has one function, html2text, which takes a an html &str and This library has one function, html2text, which takes a an html &str and
returns a plain text String returns a plain text String
on crates.io: On [crates.io](https://crates.io/crates/nanohtml2text)
https://crates.io/crates/nanohtml2text
Comes with a command line utility in main.rs to process from stdin if you want Comes with a command line utility in main.rs to process from stdin if you want
to test/experiment with it to test/experiment with it
Contributing Contributing
------------ ------------
git-send-email or git-request-pull to my mailing list: git-send-email or git-request-pull to [my mailing list](https://lists.flounder.online/patches/)
https://lists.flounder.online/patches/