xml2js/README.md

Simple XML to JavaScript object converter.

node-xml2js
===========

Description
-----------

Simple XML to JavaScript object converter. Uses [sax-js](http://github.com/isaacs/sax-js/).

See the tests for examples until docs are written.

Note: If you're looking for a full DOM parser, you probably want
[JSDom](http://github.com/tmpvar/jsdom).

Installation
------------

Simplest way to install `xml2js` is to use [npm](http://npmjs.org), just `npm
install xml2js` which will download xml2js and all dependencies.

Simple usage
-----------

    var sys = require('sys'),
        fs = require('fs'),
        xml2js = require('xml2js');

    var parser = new xml2js.Parser();
    parser.addListener('end', function(result) {
        console.log(sys.inspect(result));
        console.log('Done.');
    });
    fs.readFile(__dirname + '/foo.xml', function(err, data) {
        parser.parseString(data);
    });

Running tests, development
--------------------------

The development requirements are handled by npm, you just need to install
them. We also have a number of unittests, they can be run using `zap`
directly from the project root.