v0.4.2

* New Docs powered by Docusaurus!
* New logo courtesy of @dylanstanfield

Author: doug-martin

.eslintrc.js

@@ -16,7 +16,7 @@ module.exports = {
         node: true,
         jest: true,
     },
-    ignorePatterns: ["**/build", "**/node_modules"],
+    ignorePatterns: ["**/build", "**/node_modules", "documentation"],
     settings:{
         "import/extensions": [
             ".ts"

.gitignore

@@ -8,4 +8,4 @@ build
 coverage
 **/*.tmp.csv
 **/*.tsbuildinfo
-lerna-debug.log
+lerna-debug.log

History.md

@@ -1,3 +1,8 @@
+# v4.1.2
+
+* New Docs powered by Docusaurus!
+* New logo courtesy of [@dylanstanfield](https://github.com/dylanstanfield)
+
 # v4.1.1
 
 * [FIXED] Issue where code is not built before publishing. [#329](https://github.com/C2FO/fast-csv/issues/329)

README.md

@@ -1,44 +1,35 @@
+<p align="center">
+  <a href="https://c2fo.io/fast-csv" target="blank"><img src="https://doug-martin.github.io/nestjs-query/img/logo.svg" width="120" alt="Nestjs-query Logo" /></a>
+</p>
+
 [![npm version](https://img.shields.io/npm/v/fast-csv.svg)](https://www.npmjs.org/package/fast-csv)
 [![Build Status](https://travis-ci.org/C2FO/fast-csv.svg?branch=master)](https://travis-ci.org/C2FO/fast-csv)
 [![Coverage Status](https://coveralls.io/repos/github/C2FO/fast-csv/badge.svg?branch=master)](https://coveralls.io/github/C2FO/fast-csv?branch=master)
 [![Known Vulnerabilities](https://snyk.io/test/github/C2FO/fast-csv/badge.svg?targetFile=package.json)](https://snyk.io/test/github/C2FO/fast-csv?targetFile=package.json)
 
 # Fast-csv
 
-Fast-csv is library for parsing and formatting csvs or any other delimited value file in node. 
-
-## Packages
-
-There are three packages published from this repo.
+Fast-csv is library for parsing and formatting CSVs or any other delimited value file in node.
 
-### [`fast-csv`](./packages/fast-csv)
+## Features
 
-Exposes both formatting and parsing methods in a single package, use this if you need to parse and format files.
+* CSV Formatting
+* CSV Parsing
+* Built using typescript.
+* Flexible [formatting](https://c2fo.io/fast-csv/docs/formatting/options) and [parsing](https://c2fo.io/fast-csv/docs/parsing/options) options, to fit almost any scenario.  
+* Built with streams first to avoid creating large memory footprint when parsing large files. 
+* Battle tested in production, parsing and formatting millions of records every day.
 
-* [Docs](./packages/fast-csv/README.md)
-* [Benchmarks](./examples/benchmark/README.md)
-* [JavaScript Examples](./examples/fast-csv-js/README.md)
-* [TypeScript Examples](./examples/fast-csv-ts/README.md)
+## Install 
 
-### [`@fast-csv/parse`](./packages/parse)
+See [installation docs](./install)
 
-Parsing package, use this if you only need to parse files.
-
-* [Docs](./packages/parse/README.md)
-* [JavaScript Examples](./examples/parsing-js/README.md)
-* [TypeScript Examples](./examples/parsing-ts/README.md)
-
-### [`@fast-csv/format`](./packages/format) 
-
-Formatting package, use this if you only need to format files.
-    
-* [Docs](./packages/format/README.md)
-* [JavaScript Examples](./examples/formatting-js/README.md)
-* [TypeScript Examples](./examples/formatting-ts/README.md)
+## Packages
 
-### Migrating from older versions
 
-* [From `v2.x` to `v3.x`](./docs/migration_guide.md#from-v2x-to-v3x) 
+* `fast-csv` - One stop shop for all methods and options from `@fast-csv/format` and `@fast-csv/parse`. [Get Started!](https://c2fo.io/fast-csv/docs/introduction/getting-started)
+* `@fast-csv/parse` - Parsing package, use this if you only need to parse files. [Get Started!](https://c2fo.io/fast-csv/docs/parsing/getting-started)
+* `@fast-csv/format` - Formatting package, use this if you only need to format files. [Get Started!](https://c2fo.io/fast-csv/docs/formatting/getting-started)
 
 ## License
 

docs/contributing.md contributing.md

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

documentation/.gitignore

@@ -0,0 +1,33 @@
+# Website
+
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+```
+$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

documentation/README.md

@@ -0,0 +1,11 @@
+---
+id: initial-release
+title: Initial Release
+author: Doug Martin
+author_title: Creator
+author_url: https://github.com/doug-martin
+author_image_url: https://avatars1.githubusercontent.com/u/361261?v=4
+tags: [fast-csv, docs]
+---
+
+New docs!