Skip to content

Commit

Permalink
Animated gif for first page for github
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholas Tettenborn committed Jan 18, 2016
1 parent 213dbc5 commit d1b157e
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# rc-d3
# React Easy Chart

![animated graph](examples/images/animated-graph.gif)

# Introduction

This set of graphing components aims to be the easiest and fastest way of implementing a graph within a React application.

The graphs all have the following features:
- Easy to set up with only a requirement for data to render a chart
- Support realtime data feeds by reacting to data changes passed into the props automatically
- Fast rendering by using React to minimise the changes to the DOM as a result of data or props changes
- Configurable via props to allow features such as grids, width, height, axis and many more features to be added
- Responsive and Reactive graphs to fit to any device
- Interactive via mouse and click events allowing interesting applications to be built without graphing knowledge

Under the hood we use the fantastic [D3](http://d3js.org/) to create and render the charts into SVG. D3 requires some learning and will ultimately provide more flexible charts. The aim of React Easy Chart is to avoid that learning and have a common set of charts that can be set up in minutes.

We have concentrated on making an API that is consistent across a different set of graphs and so. Currently we provide a bar, line, area, scatter and pie chart.

##Introduction
This set of components aims to be the easiest and fastest way of implementing a graph within a React application.
Under the hood we use D3 to create and render the charts but the aim is to avoid users having to learn D3 if you want to create a standard chart.
We have concentrated on making an API that is consistent across the different graphs that at it's most basic would just require a single JSON representation of the data.
The graphs though also support more advanced use cases such as mouseover, mousemove, mouseout, on-click events.

##Background and Motivation
Expand Down
Binary file added examples/images/animated-graph.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion examples/root-styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ pre {
width: auto;
padding: 0px 10px;
background-color: #eee;
max-height: 600px;
}

h2 {
Expand Down

0 comments on commit d1b157e

Please sign in to comment.