Skip to content
This repository was archived by the owner on Jan 7, 2021. It is now read-only.

Commit 440a652

Browse files
committed
readme crap
1 parent 1ceb3f0 commit 440a652

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
1-
# XML to JSON converter
1+
# Simple XML2JSON Parser.
22

3-
## Use
3+
It does not parse the following elements:
4+
5+
* CDATA sections
6+
* Processing instructions
7+
* XML declarations
8+
* Entity declarations
9+
* Comments
10+
11+
## Installation
12+
npm install xml2json
13+
14+
## Usage
415
```javascript
516
var parser = require('xml2json');
617

718
var xml = "<foo>bar</foo>";
8-
var json = parser.toJson(xml);
19+
var json = parser.toJson(xml); //returns an string by default
920
console.log(json);
1021
```
22+
if you want to get the Javascript object then you might like to invoke parser.toJson(xml, true);
23+
1124

1225
## License
1326
Copyright 2011 BugLabs Inc. All rights reserved.

0 commit comments

Comments
 (0)