Skip to content

Commit

Permalink
Updated travis file and completed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lmammino committed Dec 18, 2016
1 parent 0bb1796 commit 5edd97d
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 17 deletions.
16 changes: 1 addition & 15 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,10 @@
language: node_js
node_js:
- "7"
- "6"
- "5"
- "4"
- "0.12"
- "0.11"
- "0.10"
env:
- CXX=g++-4.8
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8
script:
- npm test
install:
- npm install --dev
before_install:
- "npm update -g npm"
after_success:
- bash <(curl -s https://codecov.io/bash)
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,61 @@
# x2j-cli

Node.js command line script to convert XML input into JSON output (can be piped easily)
[![npm version](https://badge.fury.io/js/x2j-cli.svg)](http://badge.fury.io/js/x2j-cli)
[![Build Status](https://travis-ci.org/lmammino/x2j-cli.svg?branch=master)](https://travis-ci.org/lmammino/x2j-cli)

Node.js command line script to convert XML input into JSON output. It can be
piped to a command printing XML to stdout to have it converted and pretty printed
to JSON.


## Example

```bash
curl -sS http://www.w3schools.com/xml/note.xml | x2j
```

Will print:

```json
{
"note": {
"to": [
"Tove"
],
"from": [
"Jani"
],
"heading": [
"Reminder"
],
"body": [
"Don't forget me this weekend!"
]
}
}
```


## Install

It requires Node (0.12 or higher) and Npm (2 or higher):
It requires Node (4.0.0 or higher) and Npm (2 or higher):

```bash
npm install --global x2j-cli
```

This is going to install globally the executable `x2j` which you can use to
convert xml string from the standard input into formatted JSON into the standard
output as shown in the example above.


## Contributing

Everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/x2j-cli/issues).


## License

Licensed under [MIT License](LICENSE). © Luciano Mammino.

0 comments on commit 5edd97d

Please sign in to comment.