10000 README and CONTRIBUTING updates by etpinard · Pull Request #3 · plotly/plotly.js · GitHub
[go: up one dir, main page]
Skip to content

README and CONTRIBUTING updates #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Nov 17, 2015
Merged

README and CONTRIBUTING updates #3

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1c20baa
update README.md
etpinard Nov 15, 2015
0b18434
add Contributing.md first pass
etpinard Nov 15, 2015
f3c6ff6
update the package.json description
etpinard Nov 15, 2015
44bdee8
Merge branch 'master' into doc-updates
etpinard Nov 15, 2015
344cf5b
rm contributors section in package.json (stick to README.md)
etpinard Nov 17, 2015
9508dc8
add Chelsea to Creators section in README
etpinard Nov 17, 2015
3ab55e7
Merge branch 'master' into doc-updates
etpinard Nov 17, 2015
8a8d731
rm npm badge (for now)
etpinard Nov 17, 2015
1fa824f
small README edits
etpinard Nov 17, 2015
3f1b252
Merge branch 'doc-updates' of github.com:plotly/plotly.js into doc-up…
etpinard Nov 17, 2015
d63390a
make package.json author match README
etpinard Nov 17, 2015
d4efd4e
update CONTRIBUTING and image-test README
etpinard Nov 17, 2015
000fb10
add CHANGELOG
etpinard Nov 17, 2015
e93fa4e
minor tweak to test image README
etpinard Nov 17, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
update README.md
  • Loading branch information
@etpinard
etpinard committed Nov 15, 2015
commit 1c20baa2d6e6e734a6ddce720095c61a9e2fedf5
37 changes: 21 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# [plotly.js](https://plot.ly/javascript/getting-started/)
# [plotly.js](https://plot.ly/javascript)

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

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

## Table of contents

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

Several quick start options are available:

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

```html
Expand All @@ -34,32 +36,35 @@ Read the [Getting started page](https://plot.ly/javascript/getting-started/) for

## Bugs and feature requests

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).
Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md).

## Documentation

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.
Official plotly.js documentation is hosted on [plot.ly/javascript](https://plot.ly/javascript).

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).
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.
For more info about contributing to Plotly documentation, please read through [contributing guidelines](https://github.com/plotly/documentation/blob/source/Contributing.md).

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).

## Contributing

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.
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.

## Community

Get updates on plotly.js's development and chat with the project maintainers and community members.

* Follow [@plotlygraphs on Twitter](https://twitter.com/plotlygraphs).
* Follow [@plotlygraphs](https://twitter.com/plotlygraphs) on Twitter.
* 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).
* 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.
* Direct developer email support can be purchased through a [Plotly Pro](https://plot.ly/products/cloud/) plan.

## Versioning

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/).
plotly.js is maintained under [the Semantic Versioning guidelines](http://semver.org/).

See [the Releases section of our GitHub project](https://github.com/plotly/plotly.js/releases) for changelogs for each release version of plotly.js.
See the [Releases section](https://github.com/plotly/plotly.js/releases) of our GitHub project for changelogs for each release version of plotly.js.

## Clients for R, Python, and MATLAB

Expand All @@ -70,8 +75,8 @@ Open-source clients to the plotly.js APIs are available at these links:
|**R / RStudio**| [ropensci/plotly](https://github.com/ropensci/plotly) | [plot.ly/r/getting-started](https://plot.ly/r/getting-started) |
|**Python / Pandas / IPython notebook**| [plotly/plotly.py](https://github.com/plotly/plotly.py) | [plot.ly/python/getting-started](https://plot.ly/python/getting-started) |
|**MATLAB**| [plotly/matlab-api](https://github.com/plotly/matlab-api) | [plot.ly/matlab/getting-started](https://plot.ly/matlab/getting-started) |
|**node.js**| [plotly/plotly-nodejs](https://github.com/plotly/plotly-nodejs) | [plot.ly/nodejs/getting-started/](https://plot.ly/nodejs/getting-started/) |
|**Julia**| [plotly/Plotly.jl](https://github.com/plotly/Plotly.jl) | [plot.ly/julia/getting-started/](https://plot.ly/julia/getting-started/) |
|**node.js**| [plotly/plotly-nodejs](https://github.com/plotly/plotly-nodejs) | [plot.ly/nodejs/getting-started/](https://plot.ly/nodejs/getting-started) |
|**Julia**| [plotly/Plotly.jl](https://github.com/plotly/Plotly.jl) | [plot.ly/julia/getting-started/](https://plot.ly/julia/getting-started) |

plotly.js charts can also be created and saved online for free at [plot.ly/plot](https://plot.ly/plot).

Expand All @@ -87,6 +92,6 @@ plotly.js charts can also be created and saved online for free at [plot.ly/plot]

## Copyright and license

Code and documentation copyright 2015 Plotly, Inc.
Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
Code and documentation copyright 2015 Plotly, Inc.
Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE).
Docs released under [Creative Commons](https://github.com/plotly/documentation/blob/source/LICENSE).
0