From 942014134845eb0e51ededb66b195a6da1d34e96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Fri, 22 Apr 2016 09:44:08 -0400 Subject: [PATCH 1/4] add notes about usages --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9969f2c0d3c..fe79a1acb94 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,15 @@ chart types, including 3D charts, statistical graphs, and SVG maps. git clone https://github.com/plotly/plotly.js.git ``` +and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly/plotly.js/blob/master/dist/README.md). + #### Install with `npm` ```bash npm install plotly.js ``` +and use the plotly.js `dist` or CommonJS files `var Plotly = require('plotly.js');` in your source file. + #### Use the plotly.js CDN hosted by Fastly: ```html @@ -47,6 +51,8 @@ npm install plotly.js ``` +and use the `Plotly` object in the window scope. + Read the [Getting started page](https://plot.ly/javascript/getting-started/) for more examples. ## Modules From 9699409656ff80afa4a3f653f0fddf892b1200cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Fri, 22 Apr 2016 09:45:22 -0400 Subject: [PATCH 2/4] fix broken toc link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe79a1acb94..74e005f0524 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ chart types, including 3D charts, statistical graphs, and SVG maps. * [Documentation](#documentation) * [Contributing](#contributing) * [Community](#community) -* [Clients for R, Python, and MATLAB](#clients-for-r-python-and-matlab) +* [Clients for R, Python, and MATLAB](#clients-for-r-python-node-and-matlab) * [Creators](#creators) * [Copyright and license](#copyright-and-license) From bced519b676699c50b6941ede24e838b8e405a2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Tue, 26 Apr 2016 13:43:03 -0400 Subject: [PATCH 3/4] re-word quick usage cases --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74e005f0524..a720cec9228 100644 --- a/README.md +++ b/README.md @@ -40,14 +40,14 @@ and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly npm install plotly.js ``` -and use the plotly.js `dist` or CommonJS files `var Plotly = require('plotly.js');` in your source file. +and use the plotly.js `dist` file(s) or require plotly.js using CommonJS as `var Plotly = require('plotly.js');`. #### Use the plotly.js CDN hosted by Fastly: ```html - + ``` From 02118d71ec7cfb062365a849ae5178f79d568da4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20T=C3=A9treault-Pinard?= Date: Tue, 26 Apr 2016 14:24:40 -0400 Subject: [PATCH 4/4] add Node the API client list in toc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a720cec9228..9e9bed3258c 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ chart types, including 3D charts, statistical graphs, and SVG maps. * [Documentation](#documentation) * [Contributing](#contributing) * [Community](#community) -* [Clients for R, Python, and MATLAB](#clients-for-r-python-node-and-matlab) +* [Clients for R, Python, Node, and MATLAB](#clients-for-r-python-node-and-matlab) * [Creators](#creators) * [Copyright and license](#copyright-and-license)