update readme for browser

Author: Keyang

browser/browser.js

@@ -297,8 +297,9 @@
   },
   "scripts": {
     "dev": "tsc -w",
-    "build": "rm -Rf ./v2 && tsc && npm run build:browser",
+    "build": "rm -Rf ./v2 && tsc && npm run build:browser && npm run build:browser:window",
     "build:browser": "webpack --config ./webpack.config.js",
+    "build:browser:window": "webpack --config ./webpack.config.js --output-library-target=window --output-library=csv --output-filename=csvtojson.min.js",
     "test": "rm -Rf .ts-node && TS_NODE_CACHE_DIRECTORY=.ts-node mocha -r ts-node/register src/**/*.test.ts ./test/*.ts -R spec",
     "travis": "nyc --reporter lcov mocha -r ts-node/register src/**/*.test.ts ./test/*.ts -R spec",
     "test:debug": "mocha debug -r ts-node/register src/**/*.test.ts ./test/*.ts -R spec",

browser/csvtojson.min.js

@@ -43,6 +43,7 @@ const csvtojsonV2=require("csvtojson/v2");
 
 * [Quick Start](#quick-start)
 * [API](#api)
+* [Browser Usage](#browser-usage)
 * [Contribution](#contribution)
 
 # Quick Start
@@ -636,3 +637,43 @@ Thank you to all our sponsors! (please ask your company to also support this ope
 
 [![donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DUBQLRPJADJFQ)
 
+# Browser Usage
+
+To use `csvtojson` in browser is quite simple. There are two ways:
+
+**1. Embed script directly into script tag**
+
+There is a pre-built script located in `browser/csvtojson.min.js`. Simply include that file in a `script` tag in `index.html` page:
+
+```html
+<script src="node_modules/csvtojson/browser/csvtojson.min.js"></script>
+<!-- or use cdn -->
+<script src="https://cdn.rawgit.com/Keyang/node-csvtojson/ff908866/browser/csvtojson.min.js"></script>
+```
+then use a global `csv` function
+```html 
+<script>
+csv({
+	output: "csv"
+})
+.fromString("a,b,c\n1,2,3")
+.then(function(result){
+
+})
+</script>
+```
+
+
+
+**2. Use webpack or browserify**
+
+If a module packager is preferred, just simply `require("csvtojson")`:
+
+```js
+var csv=require("csvtojson");
+
+// or with import
+import * as csv from "csvtojson");
+
+//then use csv as normal
+```

package.json

@@ -5,6 +5,6 @@ import { Converter } from "./Converter";
 const helper = function (param?: Partial<CSVParseParam>, options?: TransformOptions): Converter {
   return new Converter(param, options);
 }
-
+helper["csv"] = helper;
 helper["Converter"] = Converter;
-export =helper;
+export =helper;

readme.md

@@ -0,0 +1,66 @@
+var webpack = require('webpack')
+var path = require('path')
+
+
+
+
+/*
+ * SplitChunksPlugin is enabled by default and replaced
+ * deprecated CommonsChunkPlugin. It automatically identifies modules which
+ * should be splitted of chunk by heuristics using module duplication count and
+ * module category (i. e. node_modules). And splits the chunks…
+ *
+ * It is safe to remove "splitChunks" from the generated configuration
+ * and was added as an educational example.
+ *
+ * https://webpack.js.org/plugins/split-chunks-plugin/
+ *
+ */
+
+/*
+ * We've enabled UglifyJSPlugin for you! This minifies your app
+ * in order to load faster and run less javascript.
+ *
+ * https://github.com/webpack-contrib/uglifyjs-webpack-plugin
+ *
+ */
+
+var UglifyJSPlugin = require('uglifyjs-webpack-plugin');
+
+
+
+
+module.exports = {
+  module: {
+    rules: []
+  },
+
+  entry: "./index.js",
+
+  output: {
+    filename: 'browser.js',
+    path: path.resolve(__dirname, 'browser'),
+    libraryTarget: "commonjs2"
+  },
+
+  mode: 'production',
+  plugins: [
+    new UglifyJSPlugin(),
+    new webpack.IgnorePlugin(/fs/),
+  ],
+  optimization: {
+    splitChunks: {
+      cacheGroups: {
+        vendors: {
+          priority: -10,
+          test: /[\\/]node_modules[\\/]/
+        }
+      },
+
+      chunks: 'async',
+      minChunks: 1,
+      minSize: 30000,
+      name: true
+    }
+  }
+}