diff --git a/.travis.yml b/.travis.yml index 0bb6784..8af9c57 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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) diff --git a/README.md b/README.md index db82d32..0ee524c 100644 --- a/README.md +++ b/README.md @@ -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.