Skip to content
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.

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

Updated README #465

Merged
merged 1 commit into from
Mar 2, 2019
Merged
Changes from all commits
Commits
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
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Perspective
# [![Perspective](https://jpmorganchase.github.io/perspective/img/title.png)](https://jpmorganchase.github.io/perspective/)

[![Build Status](https://travis-ci.org/jpmorganchase/perspective.svg?branch=master)](https://travis-ci.org/jpmorganchase/perspective)
![https://ci.appveyor.com/api/projects/status/github/jpmorganchase/perspective?svg=true](https://ci.appveyor.com/api/projects/status/github/jpmorganchase/perspective?svg=true)
[![Appveyor](https://ci.appveyor.com/api/projects/status/github/jpmorganchase/perspective?svg=true)](https://ci.appveyor.com/project/neilslinger/perspective)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/jpmorganchase/perspective)
[![npm](https://img.shields.io/npm/v/@jpmorganchase/perspective.svg?style=flat-square)](https://www.npmjs.com/package/@jpmorganchase/perspective)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
Expand All @@ -27,23 +27,27 @@ simple to build real-time & user configurable analytics entirely in the browser.
[HighCharts](https://github.com/highcharts/highcharts) and
[Hypergrid](https://github.com/fin-hypergrid/core).

- Integration with [Jupyterlab](https://github.com/jpmorganchase/perspective/tree/master/packages/perspective-jupyterlab).

- Runtimes for the Browser and Node.js.

## Examples

* [Superstore](https://bl.ocks.org/JHawk/b29192cd425bfc9443dd12626cc2f606) A static `superstore.arrow` demo.
* [Olympics](https://bl.ocks.org/JHawk/2a29387438af750614cc983f23040732) An example of sharing a single `perspective.table` among multiple `<perspective-viewer>`s.
* [Streaming](https://bl.ocks.org/JHawk/952262145299ffd7fa58d22a51de905d) A streaming random data demo.
* [Streaming Stock Trades](https://bl.ocks.org/timkpaine/064a50a309f25b80c9cfb0b2b84fbdf3) A streaming financial data demo.
* [CSV](https://bl.ocks.org/JHawk/ef28337d5c96c0360f07ca502b872c10) Upload a CSV of your own.
* [NYC Citibike](https://bl.ocks.org/JHawk/ade09a2ea62bb708cc0beab8c35609b0) An example of a join on two real-time datasets, from the NYC Citibike feed.
* [Real-time cryptocurrency charting](https://bl.ocks.org/ColinEberhardt/6e287f871410ecd970b038343b166514) An example that uses the coinbased web socket feed to plot orders in real-time
* [Financial Data from IEX](https://bl.ocks.org/timkpaine/97e0e7389875f3d21095e434e361a18f) An example that uses the [IEX cloud](https://iexcloud.io) api to build a financial dashboard.
|||
|:--|:--|
|[Superstore](https://bl.ocks.org/JHawk/b29192cd425bfc9443dd12626cc2f606)| A static `superstore.arrow` demo.|
|[Olympics](https://bl.ocks.org/JHawk/2a29387438af750614cc983f23040732)|An example of sharing a single `perspective.table` among multiple `<perspective-viewer>`s.|
|[Streaming](https://bl.ocks.org/JHawk/952262145299ffd7fa58d22a51de905d)| A streaming random data demo.|
|[Streaming Stock Trades](https://bl.ocks.org/timkpaine/064a50a309f25b80c9cfb0b2b84fbdf3)|A streaming financial data demo.|
|[CSV](https://bl.ocks.org/JHawk/ef28337d5c96c0360f07ca502b872c10)|Upload a CSV of your own.|
|[NYC Citibike](https://bl.ocks.org/JHawk/ade09a2ea62bb708cc0beab8c35609b0)|An example of a join on two real-time datasets, from the NYC Citibike feed.|
|[Real-time cryptocurrency charting](https://bl.ocks.org/ColinEberhardt/6e287f871410ecd970b038343b166514)|An example that uses the coinbased web socket feed to plot orders in real-time|
|[Financial Data from IEX](https://bl.ocks.org/timkpaine/97e0e7389875f3d21095e434e361a18f)|An example that uses the [IEX cloud](https://iexcloud.io) api to build a financial dashboard.|

## Documentation

* [Project Site](https://jpmorganchase.github.io/perspective/)
* [Installation](https://jpmorganchase.github.io/perspective/docs/installation.html)
* [User's Guide](https://jpmorganchase.github.io/perspective/docs/usage.html)
* [Developer's Guide](https://jpmorganchase.github.io/perspective/docs/development.html)
* [Perspective API](https://jpmorganchase.github.io/perspective/docs/perspective.html)
* [Perspective Viewer API](https://jpmorganchase.github.io/perspective/docs/perspective-viewer.html)
* [Perspective Viewer API](https://jpmorganchase.github.io/perspective/docs/perspective-viewer.html)