update README.md

README.md

@@ -1,3 +1,45 @@
 
 Online demo at http://syssgx.github.com/xml.js/
 
+This package exports the `xmllint` object which is an Emscripten port of
+libxml2's `xmllint` command for use in the browser or node.
+
+##### API #####
+
+```javascript
+
+Object xmllint.validateXML({
+	xml: "String",
+	schema: "String" || ["String", "String", ...]
+});
+
+```
+
+The return value Object has one property `errors` which is either null,
+in the case of no errors, or an Array of error strings....eg:
+
+```javascript
+
+if (!xmllint.validateXML(opts).errors) {
+	//there were no errors.
+}
+
+```
+
+Usable with Browserify via `browserify-shim`.
+
+#### Building xmllint from source ####
+
+Install emscripten.
+
+```
+	git clone
+	git submodule init
+	git submodule update
+	./script/clean
+	./script/libxml2
+	./script/compile
+	./script/test
+```
+
+There are also equivalent `gulp` tasks.

test/test.html

@@ -8,5 +8,11 @@
       <br>
       <input type="submit" value="validate">
     </form>
+    <!-- browserify/browserify-shim bundle test:
+      expect to see:
+        Object { errors: null } 
+      in the console log.
+    -->
+    <script src="./bundle.js"></script>
   </body>
 </html>