Skip to content

Commit

Permalink
change package name on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hariadi committed Dec 24, 2013
1 parent 8163a22 commit 26fe090
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# data-convert [![NPM version](https://badge.fury.io/js/data-convert.png)](http://badge.fury.io/js/data-convert) [![Build Status](https://github.com/assemble/data-convert.png)](https://github.com/assemble/data-convert)
# converter [![NPM version](https://badge.fury.io/js/converter.png)](http://badge.fury.io/js/converter) [![Build Status](https://github.com/assemble/converter.png)](https://github.com/assemble/converter)

> Convert between XML, JSON and YAML, from one format to another.
## Getting Started
To install the module, run the following in the command line:

```bash
npm i data-convert --save
npm i converter --save
```

Use within your application with the following line of JavaScript:

```js
var data_convert = require('data-convert');
var converter = require('converter');
```

Calling `var converter = data_convert(options);` gives you a `transform` stream that will take in data and convert it based on the options passed in.
Calling `var convert = converter(options);` gives you a `transform` stream that will take in data and convert it based on the options passed in.

```js

var fs = require('fs');
var data_convert = require('data-convert');
var converter = require('converter');

// get a file stream reader pointing to the csv file to convert
var reader = fs.createReadStream('path/to/csv/file.csv');
Expand All @@ -35,16 +35,16 @@ var options = {
};

// get a data converter stream using the given options
var converter = data_convert(options);
var convert = converter(options);

// pipe everything to do the conversion
reader.pipe(converter).pipe(writer);
reader.pipe(convert).pipe(writer);

```


## Contributing
Find a bug? Have a feature request? Please [create an Issue](https://github.com/assemble/data-convert/issues).
Find a bug? Have a feature request? Please [create an Issue](https://github.com/assemble/converter/issues).

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt][], and build the documentation with [grunt-readme](https://github.com/assemble/grunt-readme).

Expand Down Expand Up @@ -74,7 +74,7 @@ Released under the license

***

_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on Sunday, December 22, 2013._
_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on Tuesday, December 24, 2013._

[grunt]: http://gruntjs.com/
[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use within your application with the following line of JavaScript:
var {%= safename %} = require('{%= name %}');
```

Calling `var converter = {%= safename %}(options);` gives you a `transform` stream that will take in data and convert it based on the options passed in.
Calling `var convert = {%= safename %}(options);` gives you a `transform` stream that will take in data and convert it based on the options passed in.

```js

Expand All @@ -30,9 +30,9 @@ var options = {
};

// get a data converter stream using the given options
var converter = {%= safename %}(options);
var convert = {%= safename %}(options);

// pipe everything to do the conversion
reader.pipe(converter).pipe(writer);
reader.pipe(convert).pipe(writer);

```

0 comments on commit 26fe090

Please sign in to comment.