rebrand as html5tokenizer

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..531358e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# html5tokenizer
+
+This crate provides the tokenizer form [html5ever](https://crates.io/crates/html5ever),
+repackaged with all of its dependencies removed. The following dependencies were removed:
+
+* [markup5ever](https://crates.io/crates/markup5ever)  
+  `buffer_queue` and `smallcharset` were merged into the source code
+
+* [tendril](https://crates.io/crates/tendril)  
+  According to its README it contains "a substantial amount of unsafe code".
+  This fork replaces the tendril strings with plain old `std::string::String`s.
+
+* [mac](https://crates.io/crates/mac)  
+  The only macros actually needed (`format_if` and `test_eq`) were merged into
+  the source code.
+
+* [log](https://crates.io/crates/log)  
+  Was only used for debug output.
+
+If you want to parse HTML into a tree (DOM) you should by all means use
+html5ever, this crate is merely for those who only want an HTML5 tokenizer and
+seek to minimize their compile dependencies (html5ever pulls in 56).
+
+## Credits
+
+Thanks to the developers of html5ever for their awesome parser!