Skip to content

Commit

Permalink
ref #6 Updated README and bump up version to v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ryu1kn committed Aug 20, 2018
1 parent c9a24be commit 67db3f9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.1.0] - 2018-08-20
### Added
- Allow semicolon as a field delimiter as it is commonly used in CSV in some regions. Thanks to @HKskn.
[PR #8](https://github.com/ryu1kn/csv-writer/pull/8), [#6](https://github.com/ryu1kn/csv-writer/pull/6)

## [1.0.1] - 2018-08-09
### Fixed
- Fixed the issue that coverage report badge on README shows question mark.
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# CSV Writer

Convert objects/arrays into a CSV string or write them into a file.
It respects [RFC 4180](https://tools.ietf.org/html/rfc4180) for the output CSV format.

## Prerequisite

Expand Down Expand Up @@ -133,6 +134,10 @@ console.log(csvStringifier.stringifyRecords(records));
Array of objects (`id` and `title` properties) or strings (field IDs).
A header line will be written to the file only if given as an array of objects.

* fieldDelimiter `<string>` (optional)

Default: `,`. Only either comma `,` or semicolon `;` is allowed.

* encoding `<string>` (optional)

Default: `utf8`.
Expand Down Expand Up @@ -162,6 +167,10 @@ console.log(csvStringifier.stringifyRecords(records));

Array of field titles

* fieldDelimiter `<string>` (optional)

Default: `,`. Only either comma `,` or semicolon `;` is allowed.

* encoding `<string>` (optional)

Default: `utf8`.
Expand Down Expand Up @@ -201,6 +210,10 @@ console.log(csvStringifier.stringifyRecords(records));

Array of objects (`id` and `title` properties) or strings (field IDs)

* fieldDelimiter `<string>` (optional)

Default: `,`. Only either comma `,` or semicolon `;` is allowed.

##### Returns:

* `<ObjectCsvStringifier>`
Expand Down Expand Up @@ -230,6 +243,10 @@ console.log(csvStringifier.stringifyRecords(records));

Array of field titles

* fieldDelimiter `<string>` (optional)

Default: `,`. Only either comma `,` or semicolon `;` is allowed.

##### Returns:

* `<ArrayCsvStringifier>`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "csv-writer",
"version": "1.0.1",
"version": "1.1.0",
"description": "Convert objects/arrays into a CSV string or write them into a CSV file",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 67db3f9

Please sign in to comment.