path: root/bindings/hubbub/README
diff options
Diffstat (limited to 'bindings/hubbub/README')
1 files changed, 29 insertions, 0 deletions
diff --git a/bindings/hubbub/README b/bindings/hubbub/README
new file mode 100644
index 0000000..43b7be7
--- /dev/null
+++ b/bindings/hubbub/README
@@ -0,0 +1,29 @@
+Hubbub binding for libdom
+ This is an example binding of hubbub to libdom. It consists of two,
+ orthogonal, parts:
+ 1) hubbub parser wrapper
+ 2) hubbub-specific DOMImplementationSource for libdom
+Push parser wrapper
+ This is a wrapper around hubbub's parser API, to facilitate
+ construction of a libdom DOM tree. The basic premise is that the wrapper
+ intercepts the SAX-like events emitted by hubbub's tokeniser then builds
+ a libdom DOM tree from them.
+ The DOMImplementationSource exposes the APIs needed to create a new
+ document based upon the hubbub binding. It also provides the utility
+ functions that libdom uses when performing some operations (such as
+ document normalization). This is needed as libdom is document language
+ agnostic; therefore, it requires support from the binding to perform
+ some operations.