|
1 |
| -# plotly.js |
| 1 | +# [plotly.js](https://plot.ly/javascript/getting-started/) |
2 | 2 |
|
3 |
| -The premier high-level javascript graphing library |
| 3 | +[](https://www.npmjs.com/package/plotly) |
| 4 | + |
| 5 | +To get started, check out <https://plot.ly/javascript/getting-started/>! |
| 6 | + |
| 7 | +## Table of contents |
| 8 | + |
| 9 | +* [Quick start](#quick-start) |
| 10 | +* [Bugs and feature requests](#bugs-and-feature-requests) |
| 11 | +* [Documentation](#documentation) |
| 12 | +* [Contributing](#contributing) |
| 13 | +* [Community](#community) |
| 14 | +* [Clients for R, Python, and MATLAB](#clients-for-r-python-and-matlab) |
| 15 | +* [Creators](#creators) |
| 16 | +* [Copyright and license](#copyright-and-license) |
| 17 | + |
| 18 | + |
| 19 | +## Quick start |
| 20 | + |
| 21 | +Several quick start options are available: |
| 22 | + |
| 23 | +* [Download the latest release](https://github.com/plotly/plotly.js/releases/v1.0.0/plotly.js.zip). |
| 24 | +* Clone the repo: `git clone https://github.com/plotly/plotly.js.git`. |
| 25 | +* Install with [npm](https://www.npmjs.com): `npm install plotly`. |
| 26 | +* Use the plotly.js CDN hosted by Fastly: |
| 27 | + |
| 28 | +```html |
| 29 | +<!-- Latest compiled and minified plotly.js JavaScript --> |
| 30 | +<script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.min.js"> |
| 31 | +``` |
| 32 | +
|
| 33 | +Read the [Getting started page](https://plot.ly/javascript/getting-started/) for examples. |
| 34 | +
|
| 35 | +## Bugs and feature requests |
| 36 | +
|
| 37 | +Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new). |
| 38 | +
|
| 39 | +## Documentation |
| 40 | +
|
| 41 | +Plotly.js documentation, in the repo documentation, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <https://plot.ly/javascript/getting-started/>. The docs may also be run locally. |
| 42 | +
|
| 43 | +You can also suggest new documentation examples by submitting a [Codepen](http://codepen.io/tag/plotly/) on community.plot.ly (tagged [`plotly-js`](community.plot.ly/c/plotly-js). |
| 44 | +
|
| 45 | +## Contributing |
| 46 | +
|
| 47 | +Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. |
| 48 | +
|
| 49 | +## Community |
| 50 | +
|
| 51 | +Get updates on plotly.js's development and chat with the project maintainers and community members. |
| 52 | +
|
| 53 | +* Follow [@plotlygraphs on Twitter](https://twitter.com/plotlygraphs). |
| 54 | +* Implementation help may be found at Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js). |
| 55 | +* Developers should use the keyword `plotly` on packages which modify or add to the functionality of plotly.js when distributing through [npm](https://www.npmjs.com/browse/keyword/plotly) or similar delivery mechanisms for maximum discoverability. |
| 56 | +* Direct developer email support can be purchased through a [Plotly Pro](https://plot.ly/products/cloud/) plan. |
| 57 | +
|
| 58 | +## Versioning |
| 59 | +
|
| 60 | +For transparency into our release cycle and in striving to maintain backward compatibility, plotly.js is maintained under [the Semantic Versioning guidelines](http://semver.org/). |
| 61 | +
|
| 62 | +See [the Releases section of our GitHub project](https://github.com/plotly/plotly.js/releases) for changelogs for each release version of plotly.js. |
| 63 | +
|
| 64 | +## Clients for R, Python, and MATLAB |
| 65 | +
|
| 66 | +Open-source clients to the plotly.js APIs are available at these links: |
| 67 | +
|
| 68 | +| | GitHub repo | Getting started | |
| 69 | +|---|--------|---------| |
| 70 | +|**R / RStudio**| [ropensci/plotly](https://github.com/ropensci/plotly) | [plot.ly/r/getting-started](https://plot.ly/r/getting-started) | |
| 71 | +|**Python / Pandas / IPython notebook**| [plotly/plotly.py](https://github.com/plotly/plotly.py) | [plot.ly/python/getting-started](https://plot.ly/python/getting-started) | |
| 72 | +|**MATLAB**| [plotly/matlab-api](https://github.com/plotly/matlab-api) | [plot.ly/matlab/getting-started](https://plot.ly/matlab/getting-started) | |
| 73 | +|**node.js**| [plotly/plotly-nodejs](https://github.com/plotly/plotly-nodejs) | [plot.ly/nodejs/getting-started/](https://plot.ly/nodejs/getting-started/) | |
| 74 | +|**Julia**| [plotly/Plotly.jl](https://github.com/plotly/Plotly.jl) | [plot.ly/julia/getting-started/](https://plot.ly/julia/getting-started/) | |
| 75 | +
|
| 76 | +plotly.js charts can also be created and saved online for free at [plot.ly/plot](https://plot.ly/plot). |
| 77 | +
|
| 78 | +## Creators |
| 79 | +
|
| 80 | +| | Github | Twitter | |
| 81 | +|---|--------|---------| |
| 82 | +|**Alex C. Johnson**| [@alexcjohnson](https://github.com/alexcjohnson) | | |
| 83 | +|**Étienne Tétreault-Pinard**| [@etpinard](https://github.com/etpinard) | [@etpinard](https://twitter.com/etpinard) | |
| 84 | +|**Mikola Lysenko**| [@mikolalysenko](https://github.com/mikolalysenko) | [@MikolaLysenko](https://twitter.com/MikolaLysenko) | |
| 85 | +|**Ben Postlethwaite**| [@bpostlethwaite](https://github.com/bpostlethwaite) | | |
| 86 | +|**Chris Parmer**| [@chriddyp](https://github.com/chriddyp) | | |
| 87 | +
|
| 88 | +## Copyright and license |
| 89 | +
|
| 90 | +Code and documentation copyright 2015 Plotly, Inc. |
| 91 | +Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE). |
| 92 | +Docs released under [Creative Commons](https://github.com/plotly/documentation/blob/source/LICENSE). |
0 commit comments