init repo

Author: David Frank

.gitignore

@@ -25,3 +25,9 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+
+# OS files
+.DS_Store
+
+# Coveralls token files
+.coveralls.yml

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "0.12"
+  - "iojs"
+before_install: npm install -g npm
+script: npm run coverage

CHANGELOG.md

@@ -0,0 +1,10 @@
+
+Changelog
+=========
+
+
+# 1.x release
+
+## v1.0.0
+
+- Major: initial public release

LICENSE LICENSE.md

@@ -1,2 +1,78 @@
-# vdom-parser
-A dom to vdom parser based on DOMParser
+
+vdom-parser
+===========
+
+[![npm version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![coverage status][coveralls-image]][coveralls-url]
+
+A client-side DOM to vdom parser based on DOMParser API, compatible with [virtual-dom](https://github.com/Matt-Esch/virtual-dom).
+
+
+# Motivation
+
+We use `virtual-dom` with progressive enhancement in mind: we use server-side rendering to achieve good first-page performance then re-attach vdom rendering client-side.
+
+This means we need a solid implementation of html to vdom parser, while there are [existing implementations](https://github.com/Matt-Esch/virtual-dom/wiki#html-to-vdom), we would like a solution that's well-tested and make use of existing browser API.
+
+Hence `vdom-parser`, a small module that bridges the gap between server-side and client-side rendering.
+
+
+# Features
+
+- Use [DOMParser](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser) for better performance and much smaller filesize.
+- Peer dependent on `virtual-dom` major version to prevent version lockdown.
+- Test cases to cover common usage such as inline svg.
+
+
+# Install
+
+`npm install vdom-parser --save`
+
+
+# Usage
+
+```javascript
+// server-side render
+var parser = require('vdom-parser');
+var nodeCache = document.body;
+var vdomCache = parser(nodeCache);
+
+// client-side render
+var vdom = h('div', 'hello');
+
+// diff and patch
+var patches = diff(vdomCache, vdom);
+patch(nodeCache, patches);
+```
+
+See [test cases](https://github.com/bitinn/vdom-parser/blob/master/test/test.js) for more examples.
+
+
+# API
+
+## parser(node)
+
+Returns a `VNode`
+
+### node
+
+Should be a DOM Element
+
+
+# License
+
+MIT
+
+
+# Acknowledgement
+
+Thanks to [marcelklehr/vdom-virtualize](https://github.com/marcelklehr/vdom-virtualize) and [TimBeyer/html-to-vdom](https://github.com/TimBeyer/html-to-vdom) for providing reference on this topic.
+
+
+[npm-image]: https://img.shields.io/npm/v/vdom-parser.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/vdom-parser
+[travis-image]: https://img.shields.io/travis/bitinn/vdom-parser.svg?style=flat-square
+[travis-url]: https://travis-ci.org/bitinn/vdom-parser
+[coveralls-image]: https://img.shields.io/coveralls/bitinn/vdom-parser.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/r/bitinn/vdom-parser

README.md

@@ -0,0 +1,21 @@
+
+/**
+ * index.js
+ *
+ * A client-side DOM to vdom parser based on DOMParser API
+ */
+
+var VNode = require('virtual-dom/VNode');
+var VText = require('virtual-dom/VText');
+
+module.exports = parser;
+
+/**
+ * DOM to vdom parser
+ *
+ * @param   Object  el  DOM element  
+ * @return  Object      VNode or VText
+ */
+function parser(el) {
+
+}

index.js

@@ -0,0 +1,34 @@
+{
+  "name": "vdom-parser",
+  "version": "1.0.0",
+  "description": "A client-side DOM to vdom parser based on DOMParser API, compatible with virtual-dom",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha-phantomjs test/index.html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bitinn/vdom-parser.git"
+  },
+  "keywords": [
+    "dom",
+    "vdom",
+    "parser",
+    "virtual-dom"
+  ],
+  "author": "David Frank",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bitinn/vdom-parser/issues"
+  },
+  "homepage": "https://github.com/bitinn/vdom-parser#readme",
+  "peerDependencies": {
+    "virtual-dom": "2.x"
+  },
+  "devDependencies": {
+    "chai": "^3.0.0",
+    "mocha": "^2.2.5",
+    "mocha-phantomjs": "^3.5.3",
+    "phantomjs": "^1.9.17"
+  }
+}