docs: create initial project readme guide

Author: Harrison Ifeanyichukwu

README.md

@@ -1,2 +1,27 @@
-# xml-serializer
-A javascript implementation of w3c xml-serialization spec
+# XML-Serializer
+
+XML-Serializer is A JavaScript implementation of w3c [xml serialization](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-xml) spec. All specifications have been implemented and includes the following [specs](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-xml-serialization-algorithm):
+
+- [Element node Serialization]
+
+- [Document node Serialization]
+
+- [Comment node Serialization]
+
+- [Text node Serialization]
+
+- [Document Fragment node Serialization]
+
+- [Document Type Serialization]
+
+- [Processing Instruction Serialization]
+
+## Module Availability
+
+This module is available as an npm package and also as a browser module. It can easily integrated with [JSDOM](https://github.com/jsdom/jsdom) for mockup testing.
+
+## Useful Articles
+
+In addition to the spec, the following sections as well as outside resources were consulted and proved very useful:
+
+[serialize-doc-type](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-doctype), [serialize-xml-attribute](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-xml-attributes), [serialize-attr-value](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-serialize-attr-value), [record-element-namespace-info](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-record-namespace-info), [generate-prefix](https://www.w3.org/TR/DOM-Parsing/#dfn-concept-generate-prefix), [xml-character-sets](https://www.w3.org/TR/xml/), [detect-non-valid-xml-characters](https://stackoverflow.com/questions/29031792/detect-non-valid-xml-characters-javascript)