Skip to content

Commit

Permalink
docs: readme minor formating
Browse files Browse the repository at this point in the history
  • Loading branch information
wdavidw committed Jul 27, 2024
1 parent 1b2067c commit 341c7bb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 35 deletions.
23 changes: 3 additions & 20 deletions packages/csv-stringify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@
[![NPM](https://img.shields.io/npm/dm/csv-stringify)](https://www.npmjs.com/package/csv-stringify)
[![NPM](https://img.shields.io/npm/v/csv-stringify)](https://www.npmjs.com/package/csv-stringify)

The [`csv-stringify` package](https://csv.js.org/stringify/) is a stringifier converting records into a CSV text and
implementing the Node.js [`stream.Transform`
API](https://nodejs.org/api/stream.html). It also provides the easier
synchronous and callback-based APIs for conveniency. It is both extremely easy
to use and powerful. It was first released in 2010 and is tested against big
data sets by a large community.
The [`csv-stringify` package](https://csv.js.org/stringify/) is a stringifier converting records into a CSV text and implementing the Node.js [`stream.Transform` API](https://nodejs.org/api/stream.html). It also provides the easier synchronous and callback-based APIs for conveniency. It is both extremely easy to use and powerful. It was first released in 2010 and is tested against big data sets by a large community.

## Documentation

Expand Down Expand Up @@ -54,26 +49,14 @@ assert.equal(output, '1,2,3,4\na,b,c,d\n');

## Development

Tests are executed with mocha. To install it, run `npm install` followed by `npm
test`. It will install mocha and its dependencies in your project "node_modules"
directory and run the test suite. The tests run against the CoffeeScript source
files.
Tests are executed with mocha. To install it, run `npm install` followed by `npm test`. It will install mocha and its dependencies in your project "node_modules" directory and run the test suite. The tests run against the CoffeeScript source files.

To generate the JavaScript files, run `npm run build`.

The test suite is run online with
[Travis](https://travis-ci.org/#!/adaltas/node-csv-stringify). See the [Travis
definition
file](https://github.com/adaltas/node-csv-stringify/blob/master/.travis.yml) to
view the tested Node.js version.
The test suite is run online with [Travis](https://travis-ci.org/#!/adaltas/node-csv-stringify). See the [Travis definition file](https://github.com/adaltas/node-csv-stringify/blob/master/.travis.yml) to view the tested Node.js version.

## Contributors

The project is sponsored by [Adaltas](https://www.adaltas.com), an Big Data consulting firm based in Paris, France.

* David Worms: <https://github.com/wdavidw>

[csv_home]: https://github.com/adaltas/node-csv
[stream_transform]: http://nodejs.org/api/stream.html#stream_class_stream_transform
[examples]: https://csv.js.org/stringify/examples/
[csv]: https://github.com/adaltas/node-csv
19 changes: 4 additions & 15 deletions packages/csv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@
[![Build Status](https://img.shields.io/github/actions/workflow/status/adaltas/node-csv/nodejs.yml?branch=master)](https://github.com/adaltas/node-csv/actions)
[![NPM](https://img.shields.io/npm/dm/csv)](https://www.npmjs.com/package/csv) [![NPM](https://img.shields.io/npm/v/csv)](https://www.npmjs.com/package/csv)

The `csv` project provides CSV generation, parsing, transformation and serialization
for Node.js.
The `csv` project provides CSV generation, parsing, transformation and serialization for Node.js.

It has been tested and used by a large community over the years and should be
considered reliable. It provides every option you would expect from an advanced
CSV parser and stringifier.
It has been tested and used by a large community over the years and should be considered reliable. It provides every option you would expect from an advanced CSV parser and stringifier.

This package exposes 4 packages:

Expand All @@ -34,8 +31,7 @@ The full documentation for the current version is available [here](https://csv.j

Installation command is `npm install csv`.

Each package is fully compatible with the Node.js stream 2 and 3 specifications.
Also, a simple callback-based API is always provided for convenience.
Each package is fully compatible with the Node.js stream 2 and 3 specifications. Also, a simple callback-based API is always provided for convenience.

## Sample

Expand Down Expand Up @@ -72,8 +68,7 @@ csv

## Development

This parent project doesn't have tests itself but instead delegates the
tests to its child projects.
This parent project doesn't have tests itself but instead delegates the tests to its child projects.

Read the documentation of the child projects for additional information.

Expand All @@ -88,9 +83,3 @@ The project is sponsored by [Adaltas](https://www.adaltas.com), an Big Data cons
* Pavel Kolesnikov "ya-csv": <http://github.com/koles/ya-csv>
* Chris Williams "node-csv": <http://github.com/voodootikigod/node-csv>
* Mat Holt "PapaParse": <https://github.com/mholt/PapaParse>

[travis]: https://travis-ci.org/
[travis-csv-generate]: http://travis-ci.org/adaltas/node-csv-generate
[travis-csv-parse]: http://travis-ci.org/adaltas/node-csv-parse
[travis-stream-transform]: http://travis-ci.org/adaltas/node-stream-transform
[travis-csv-stringify]: http://travis-ci.org/adaltas/node-csv-stringify

0 comments on commit 341c7bb

Please sign in to comment.