finishing touches

Author: mdtusz

README.md

@@ -1,6 +1,6 @@
 <a href="https://plot.ly/javascript/"><img src="http://images.plot.ly/logo/plotlyjs-logo@2x.png" height="70"></a>
 
-[![npm version](https://badge.fury.io/js/plotly.js.svg)](https://badge.fury.io/js/plotly.js) 
+[![npm version](https://badge.fury.io/js/plotly.js.svg)](https://badge.fury.io/js/plotly.js)
 [![circle ci](https://circleci.com/gh/plotly/plotly.js.png?&style=shield&circle-token=1f42a03b242bd969756fc3e53ede204af9b507c0)](https://circleci.com/gh/plotly/plotly.js)
 
 Built on top of [d3.js](http://d3js.org/) and [stack.gl](http://stack.gl/),
@@ -40,7 +40,33 @@ npm install plotly.js
 <script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.min.js"></script>
 ```
 
-Read the [Getting started page](https://plot.ly/javascript/getting-started/) for examples.
+#### Webpack Usage
+
+Plotly.js uses a browserify transform (glslify) to transform shaders. To make this work with Webpack, you will need to install [ify-loader]() and add it to your `webpack.config.json`.
+
+Read the [Getting started page](https://plot.ly/javascript/getting-started/) for more examples.
+
+## Modules
+
+If you would like to reduce the bundle size of plotly.js, you can create a "custom" bundle by using `plotly.js/lib/core`, and loading only the trace types that you need (e.g. `pie` or `choropleth`). The recommended way to do this is by creating a "bundling file":
+
+```javascript
+// custom-plotly.js
+var plotlyCore = require('plotly.js/lib/core');
+
+// Load in the trace types for pie, and choropleth
+plotlyCore.register([
+    require('plotly.js/lib/pie');
+    require('plotly.js/lib/choropleth');
+]);
+
+module.exports = customPlotly;
+```
+Then elsewhere in your code:
+
+```javascript
+var Plotly = require('./custom-plotly');
+```
 
 ## Bugs and feature requests
 

src/core.js

@@ -14,8 +14,8 @@
 
 var Plotly = require('./plotly');
 
-// export the version found in the package.json
-exports.version = require('../package.json').version;
+// package version injected by `npm run preprocess`
+exports.version = '1.4.1';
 
 // plot api
 exports.plot = Plotly.plot;

src/index.js

@@ -14,9 +14,6 @@
 
 var Core = require('./core');
 
-// package version injected by `npm run preprocess`
-exports.version = '1.4.1';
-
 // Load all trace modules
 Core.register([
     require('./traces/bar'),

tasks/preprocess.js

@@ -31,5 +31,5 @@ fs.copy(constants.pathToTopojsonSrc, constants.pathToTopojsonDist,
 );
 
 // inject package version into source index files
-updateVersion(constants.pathToPlotlySrc);
+updateVersion(constants.pathToPlotlyCore);
 updateVersion(constants.pathToPlotlyGeoAssetsSrc);

tasks/util/constants.js

@@ -19,6 +19,7 @@ module.exports = {
     pathToSrc: pathToSrc,
 
     pathToPlotlySrc: path.join(pathToSrc, 'index.js'),
+    pathToPlotlyCore: path.join(pathToSrc, 'core.js'),
     pathToPlotlyBuild: path.join(pathToBuild, 'plotly.js'),
     pathToPlotlyDist: path.join(pathToDist, 'plotly.js'),
     pathToPlotlyDistMin: path.join(pathToDist, 'plotly.min.js'),