|
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 | +* [Creators](#creators) |
| 15 | +* [Copyright and license](#copyright-and-license) |
| 16 | + |
| 17 | + |
| 18 | +## Quick start |
| 19 | + |
| 20 | +Several quick start options are available: |
| 21 | + |
| 22 | +* [Download the latest release](https://github.com/plotly/plotly.js/releases/v1.0.0/plotly.js.zip). |
| 23 | +* Clone the repo: `git clone https://github.com/plotly/plotly.js.git`. |
| 24 | +* Install with [npm](https://www.npmjs.com): `npm install plotly`. |
| 25 | + |
| 26 | +Read the [Getting started page](https://plot.ly/javascript/getting-started/) for examples. |
| 27 | + |
| 28 | +## Bugs and feature requests |
| 29 | + |
| 30 | +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). |
| 31 | + |
| 32 | +## Documentation |
| 33 | + |
| 34 | +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. |
| 35 | + |
| 36 | +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). |
| 37 | + |
| 38 | +### Running documentation locally |
| 39 | + |
| 40 | +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v3.0.x). |
| 41 | + **Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. |
| 42 | +2. Make sure that you're on the ```source``` branch. |
| 43 | +3. From the root `/documentation` directory, run `jekyll serve` in the command line. |
| 44 | +4. Open `http://localhost:8000` in your browser, and voilà. |
| 45 | + |
| 46 | +Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). |
| 47 | + |
| 48 | +## Contributing |
| 49 | + |
| 50 | +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. |
| 51 | + |
| 52 | +## Community |
| 53 | + |
| 54 | +Get updates on plotly.js's development and chat with the project maintainers and community members. |
| 55 | + |
| 56 | +* Follow [@plotlygraphs on Twitter](https://twitter.com/plotlygraphs). |
| 57 | +* Implementation help may be found at Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or community.plot.ly (tagged [`plotly-js`](community.plot.ly/c/plotly-js). |
| 58 | +* 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. |
| 59 | +* Direct developer email support can be purchased through a [Plotly Pro](https://plot.ly/products/cloud/) plan. |
| 60 | + |
| 61 | +## Versioning |
| 62 | + |
| 63 | +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/). |
| 64 | + |
| 65 | +See [the Releases section of our GitHub project](https://github.com/plotly/plotly.js/releases) for changelogs for each release version of plotly.js. |
| 66 | + |
| 67 | + |
| 68 | +## Creators |
| 69 | + |
| 70 | +**Alex C. Johnson** |
| 71 | + |
| 72 | +* <https://github.com/alexcjohnson> |
| 73 | + |
| 74 | +**Étienne Tétreault-Pinard** |
| 75 | + |
| 76 | +* <https://twitter.com/fat> |
| 77 | +* <https://github.com/fat> |
| 78 | + |
| 79 | +**Mikola Lysenko** |
| 80 | + |
| 81 | +* <https://twitter.com/MikolaLysenko> |
| 82 | +* <https://github.com/mikolalysenko> |
| 83 | + |
| 84 | +**Ben Postlethwaite** |
| 85 | + |
| 86 | +* <https://github.com/bpostlethwaite> |
| 87 | + |
| 88 | +**Chris Parmer** |
| 89 | + |
| 90 | +* <https://github.com/chriddyp> |
| 91 | + |
| 92 | +## Copyright and license |
| 93 | + |
| 94 | +Code and documentation copyright 2015 Plotly, Inc. |
| 95 | +Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE). |
| 96 | +Docs released under [Creative Commons](https://github.com/plotly/documentation/blob/source/LICENSE). |
0 commit comments