upd Readme & add License file

voischev · voischev · commit 6036ea9d52a3 · 2015-10-20T00:08:36.000+03:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2015 Ivan Voischev <voischev.ivan@ya.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -2,3 +2,97 @@
 [![npm version](https://badge.fury.io/js/posthtml-render.svg)](http://badge.fury.io/js/posthtml-render)
 [![Build Status](https://travis-ci.org/voischev/posthtml-render.svg?branch=master)](https://travis-ci.org/voischev/posthtml-render?branch=master)
 [![Coverage Status](https://coveralls.io/repos/voischev/posthtml-render/badge.svg?branch=master)](https://coveralls.io/r/voischev/posthtml-render?branch=master)
+
+Render [PostHTML](http://github.com/posthtml/posthtml) Tree to HTML/XML.
+More info for [PostHTMLTree](https://github.com/posthtml/posthtml#posthtml-json-tree-example)
+
+## Install
+
+[NPM](http://npmjs.com) install
+```
+$ npm install posthtml-render
+```
+is also available for [bower](http://bower.io) and as an AMD, CommonJS, and globals module, uncompressed and compressed.
+
+
+## Usage
+
+__In NodeJS__
+
+```js
+var render = require('posthtml-render');
+var titleObj = { tag: 'h1' };
+
+titleObj.attrs = { class: 'heading' };
+titleObj.content = ['Title'];
+
+clonsole.log(render(titleObj/*, options */));
+// <h1 class="heading">Title</h1>
+```
+
+__In Browser__
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Title</title>
+    <script type="text/javascript" src="./bower_components/posthtml-render/posthtml-render.min.js"></script>
+    <script type="text/javascript">
+        window.onload = function() {
+            document.body.innerHTML = postHTMLRender({ tag: 'h1', attrs: { style: 'color: red;' }, content: ['Title'] });
+        };
+    </script>
+</head>
+<body>
+
+</body>
+</html>
+```
+
+## Options
+
+### singleTags
+Array tags for extend default list single tags
+
+__Default__: `[]`
+
+*Options* `{ singleTags: ['rect', 'custom'] }`
+
+```html
+...
+<div>
+    ...
+    <rect>
+    <custom>
+</div>
+```
+
+
+### closingSingleTag
+Option to specify version closing single tags.
+Accepts values: `default`, `slash`, `tag`.
+
+__Default__: `default`
+
+*Options* `{ closingSingleTag: 'default' }`
+
+```html
+<img>
+```
+
+*Options* `{ closingSingleTag: 'slash' }`
+
+```html
+<img />
+```
+
+*Options* `{ closingSingleTag: 'tag' }`
+
+```html
+<img></img>
+```
+
+## License
+
+[MIT](LICENSE)
