Add some documentation

[mardy]

Hi! I was about to start writing a Qt port of python's html.parser module, when I found this project. It looks exactly like what I need, except that it's not clear how to use it :-)

The example command provided does not show how to hook up to the various processing phases, and the main header file htmlparser.h does not offer any virtual methods that could be reimplemented in order to be notified of the various elements being parsed.

[dantti]

This project is not finished, 99% of the HTML parsing follows the standard but it's currently a bit useless as it still needs to build a tree to be manipulated, I was hopping to get some paid project that could make use of it or some dev in need to finish it as I don't have the time ATM, take a look at:
https://github.com/cutelyst/html-qt/blob/master/cmd/main.cpp
for "how to use"