react-dom-parser - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

@@ -18,3 +18,3 @@ {
   "main": "index.js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "devDependencies": {
@@ -21,0 +21,0 @@ "react": "^0.14.2",

README.md

 # React-DOM-Parser
-A DOM parser for the react library, used for instantiating react components declaratively
+A DOM parser for the react.js library, used for instantiating react components declaratively.
+
+## Installation
+	npm install react-dom-parser --save-dev
+
+## Example
+
+html declaration
+
+	<div data-react-component="my-module" data-react-props="
+		name: 'simon staton',
+		data: {
+			age: 23
+		}
+	"></div>
+
+Before instantiating a react component you must first register it in the parsers registry.
+	
+	var parser = require('react-dom-parser');
+
+	var myReactComponent = React.createClass({
+		render: function(){
+			return ...
+		}
+	});
+
+	parser.register('my-module', myReactComponent);
+
+	parser.register({
+		my-module: myReactComponent
+	});
+
+Once modules have been registered you may parse the DOM to instantiate them
+
+	parser.parse(document.getElementsByTagName("BODY")[0]);

No alert changes

Improved metrics

Total package byte prevSize

4613

17.17%

Number of lines in readme file

36

1100%

No dependency changes