Skip to content

Commit 1c20baa

Browse files
committed
update README.md
1 parent 33beb43 commit 1c20baa

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# [plotly.js](https://plot.ly/javascript/getting-started/)
1+
# [plotly.js](https://plot.ly/javascript)
22

3-
[![npm version](https://img.shields.io/npm/v/plotly.svg)](https://www.npmjs.com/package/plotly)
3+
[![npm version](https://img.shields.io/npm/v/plotly.svg)](https://www.npmjs.com/package/plotly.js)
44

5-
To get started, check out <https://plot.ly/javascript/getting-started/>!
5+
Built on top of [d3.js](http://d3js.org/) and [stack.gl](http://stack.gl/),
6+
plotly.js is a high-level, declarative charting library. plotly.js ships with 20
7+
chart types, including 3D charts, statistical graphs, and SVG maps.
68

79
## Table of contents
810

@@ -20,9 +22,9 @@ To get started, check out <https://plot.ly/javascript/getting-started/>!
2022

2123
Several quick start options are available:
2224

23-
* [Download the latest release](https://github.com/plotly/plotly.js/releases/v1.0.0/plotly.js.zip).
25+
* [Download the latest release](https://github.com/plotly/plotly.js/releases/).
2426
* Clone the repo: `git clone https://github.com/plotly/plotly.js.git`.
25-
* Install with [npm](https://www.npmjs.com): `npm install plotly`.
27+
* Install with [npm](https://www.npmjs.com): `npm install plotly.js`.
2628
* Use the plotly.js CDN hosted by Fastly:
2729

2830
```html
@@ -34,32 +36,35 @@ Read the [Getting started page](https://plot.ly/javascript/getting-started/) for
3436
3537
## Bugs and feature requests
3638
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).
39+
Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md).
3840
3941
## Documentation
4042
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.
43+
Official plotly.js documentation is hosted on [plot.ly/javascript](https://plot.ly/javascript).
4244
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).
45+
These pages are generated by the Plotly [documentation repo](https://github.com/plotly/documentation/tree/gh-pages) built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages.
46+
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/documentation/blob/source/Contributing.md).
47+
48+
You can also suggest new documentation examples by submitting a [Codepen](http://codepen.io/tag/plotly/) on community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js).
4449
4550
## Contributing
4651
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.
52+
Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, using plotly.js in your project and notes on development.
4853
4954
## Community
5055
5156
Get updates on plotly.js's development and chat with the project maintainers and community members.
5257
53-
* Follow [@plotlygraphs on Twitter](https://twitter.com/plotlygraphs).
58+
* Follow [@plotlygraphs](https://twitter.com/plotlygraphs) on Twitter.
5459
* 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).
5560
* 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.
5661
* Direct developer email support can be purchased through a [Plotly Pro](https://plot.ly/products/cloud/) plan.
5762
5863
## Versioning
5964
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/).
65+
plotly.js is maintained under [the Semantic Versioning guidelines](http://semver.org/).
6166
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.
67+
See the [Releases section](https://github.com/plotly/plotly.js/releases) of our GitHub project for changelogs for each release version of plotly.js.
6368
6469
## Clients for R, Python, and MATLAB
6570
@@ -70,8 +75,8 @@ Open-source clients to the plotly.js APIs are available at these links:
7075
|**R / RStudio**| [ropensci/plotly](https://github.com/ropensci/plotly) | [plot.ly/r/getting-started](https://plot.ly/r/getting-started) |
7176
|**Python / Pandas / IPython notebook**| [plotly/plotly.py](https://github.com/plotly/plotly.py) | [plot.ly/python/getting-started](https://plot.ly/python/getting-started) |
7277
|**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/) |
78+
|**node.js**| [plotly/plotly-nodejs](https://github.com/plotly/plotly-nodejs) | [plot.ly/nodejs/getting-started/](https://plot.ly/nodejs/getting-started) |
79+
|**Julia**| [plotly/Plotly.jl](https://github.com/plotly/Plotly.jl) | [plot.ly/julia/getting-started/](https://plot.ly/julia/getting-started) |
7580
7681
plotly.js charts can also be created and saved online for free at [plot.ly/plot](https://plot.ly/plot).
7782
@@ -87,6 +92,6 @@ plotly.js charts can also be created and saved online for free at [plot.ly/plot]
8792
8893
## Copyright and license
8994
90-
Code and documentation copyright 2015 Plotly, Inc.
91-
Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
95+
Code and documentation copyright 2015 Plotly, Inc.
96+
Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
9297
Docs released under [Creative Commons](https://github.com/plotly/documentation/blob/source/LICENSE).

0 commit comments

Comments
 (0)