diff options
Diffstat (limited to 'node_modules/xmlbuilder/README.md')
| -rw-r--r-- | node_modules/xmlbuilder/README.md | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/node_modules/xmlbuilder/README.md b/node_modules/xmlbuilder/README.md new file mode 100644 index 0000000..d15b627 --- /dev/null +++ b/node_modules/xmlbuilder/README.md @@ -0,0 +1,103 @@ +# xmlbuilder-js
+
+An XML builder for [node.js](https://nodejs.org/) similar to
+[java-xmlbuilder](https://github.com/jmurty/java-xmlbuilder).
+
+[](http://opensource.org/licenses/MIT)
+[](https://npmjs.com/package/xmlbuilder)
+[](https://npmjs.com/package/xmlbuilder)
+
+[](http://travis-ci.org/oozcitak/xmlbuilder-js)
+[](https://ci.appveyor.com/project/oozcitak/xmlbuilder-js)
+[](https://david-dm.org/oozcitak/xmlbuilder-js)
+[](https://coveralls.io/github/oozcitak/xmlbuilder-js)
+
+### Announcing `xmlbuilder2`:
+
+The new release of `xmlbuilder` is available at [`xmlbuilder2`](https://github.com/oozcitak/xmlbuilder2)! `xmlbuilder2` has been redesigned from the ground up to be fully conforming to the [modern DOM specification](https://dom.spec.whatwg.org). It supports XML namespaces, provides built-in converters for multiple formats, collection functions, and more. Please see [upgrading from xmlbuilder](https://oozcitak.github.io/xmlbuilder2/upgrading-from-xmlbuilder.html) in the wiki.
+
+New development will be focused towards `xmlbuilder2`; `xmlbuilder` will only receive critical bug fixes.
+
+### Installation:
+
+``` sh
+npm install xmlbuilder
+```
+
+### Usage:
+
+``` js
+var builder = require('xmlbuilder');
+
+var xml = builder.create('root')
+ .ele('xmlbuilder')
+ .ele('repo', {'type': 'git'}, 'git://github.com/oozcitak/xmlbuilder-js.git')
+ .end({ pretty: true});
+
+console.log(xml);
+```
+
+will result in:
+
+``` xml
+<?xml version="1.0"?>
+<root>
+ <xmlbuilder>
+ <repo type="git">git://github.com/oozcitak/xmlbuilder-js.git</repo>
+ </xmlbuilder>
+</root>
+```
+
+It is also possible to convert objects into nodes:
+
+``` js
+var builder = require('xmlbuilder');
+
+var obj = {
+ root: {
+ xmlbuilder: {
+ repo: {
+ '@type': 'git', // attributes start with @
+ '#text': 'git://github.com/oozcitak/xmlbuilder-js.git' // text node
+ }
+ }
+ }
+};
+
+var xml = builder.create(obj).end({ pretty: true});
+console.log(xml);
+```
+
+If you need to do some processing:
+
+``` js
+var builder = require('xmlbuilder');
+
+var root = builder.create('squares');
+root.com('f(x) = x^2');
+for(var i = 1; i <= 5; i++)
+{
+ var item = root.ele('data');
+ item.att('x', i);
+ item.att('y', i * i);
+}
+
+var xml = root.end({ pretty: true});
+console.log(xml);
+```
+
+This will result in:
+
+``` xml
+<?xml version="1.0"?>
+<squares>
+ <!-- f(x) = x^2 -->
+ <data x="1" y="1"/>
+ <data x="2" y="4"/>
+ <data x="3" y="9"/>
+ <data x="4" y="16"/>
+ <data x="5" y="25"/>
+</squares>
+```
+
+See the [wiki](https://github.com/oozcitak/xmlbuilder-js/wiki) for details and [examples](https://github.com/oozcitak/xmlbuilder-js/wiki/Examples) for more complex examples.
|