Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
beto-rodriguez authored Nov 26, 2016
1 parent 17c5f30 commit 7065aba
Showing 1 changed file with 34 additions and 64 deletions.
98 changes: 34 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,57 @@
<p align="center">
<a href="http://lvcharts.net/"><img src="http://lvcharts.net/Content/Images/Logos/LiveChartsLogo.png" /></a>
</p>

<p align="center">
<img src="https://lvcharts.net/content/images/darkpanel.gif" />
 <a href="http://lvcharts.net/"><img src="http://lvcharts.net/Content/Images/LiveChartsWhite.gif" /></a>
</p>

[![GitHub license](https://img.shields.io/github/license/beto-rodriguez/Live-Charts.svg?style=flat-square)](https://github.com/beto-rodriguez/Live-Charts/blob/master/LICENSE.TXT)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/707m8sye0ggbfrcq)](https://ci.appveyor.com/project/beto-rodriguez/live-charts)
[![GitHub issues](https://img.shields.io/github/issues/beto-rodriguez/Live-Charts.svg?style=flat-square)](https://github.com/beto-rodriguez/Live-Charts/issues)
[![Gitter](https://img.shields.io/gitter/room/beto-rodriguez/Live-Charts.svg?style=flat-square)](https://gitter.im/beto-rodriguez/Live-Charts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

* **[WebSite](http://lvcharts.net/)**
* **[Get Started Here](http://lvcharts.net/App/examples/wpf/start)**, this repository has much more examples also.
* **[Chat](https://gitter.im/beto-rodriguez/Live-Charts)**
* **Questions and support?**, we are always happy to help you at our chat, if you require so you can also try [Stack Overflow](http://stackoverflow.com/questions/tagged/livecharts).

<hr/>

**What is Live-Charts?**

Animated, MVVM orientated .Net charts, for WPF, WinForms under MIT Licence, written in C#, LiveCharts listens for any change in your data automatically and updates UI.

Live charts makes your data alive, as easy as manipulating any .net list, the library animates and updates every time your data changes.
### LiveCharts is
# Flexible, Customizable

it also is:
*images in this section are build with LiveCharts, but designed by [Kingyo](https://dribbble.com/Kingyo)*

- Good looking, animated and easy to customize charts, you can practically change all properties.
- Autoupdate UI, you just create a SeriesCollection, then LiveCharts will handle everything.
- MVVM Charting, Support for WPF Bindings.
- Supports zooming and panning.
- MIT License, permissive licensing, yes free.

**Why is LiveCharts different to other charting libraries?**

First: animations and good looking charts by default, second: responsive charts these charts automatically update when your data changes also when you resize your chart, finally LiveCharts MVVM is different and for me it feels better than other libraries, becuase LiveCharts uses generics and with it strongly typed modeling, others use reflection to get the property value.

**How to use it?**
<p align="center">
<img src="http://lvcharts.net/Content/Images/materialcards.gif" />
</p>
<p align="center">
<img src="http://lvcharts.net/Content/Images/energy.gif" />
</p>
<p align="center">
<img src="http://lvcharts.net/Content/Images/solid.gif" />
</p>

This is the logic you use in every chart, there are just some little properties or rules that change from each type of chart
### it is also
# Simple, Interactive

```c#
//create a new SeriesCollection
var seriesCollection = new SeriesCollection();
As easy as manipulating any generic list in .Net, LiveCharts updates and animates as your data changes in real time, charts are also sensitive to size changes.

//create some LineSeries if you need so, there are many supported series
var charlesSeries = new LineSeries
{
Title = "Charles",
Values = new ChartValues<double> {10, 5, 7, 5, 7, 8}
};
var jamesSeries = new LineSeries
{
Title = "James",
Values = new ChartValues<double> { 5, 6, 9, 10, 11, 9 }
};
<p align="center">
<img src="https://lvcharts.net/Content/Images/Banner/linq.gif" />
<img src="https://lvcharts.net/Content/Images/Banner/responsive.gif" />
<img src="https://lvcharts.net/Content/Images/Banner/doughnut.gif" />/
<img src="https://lvcharts.net/Content/Images/Banner/constant.gif" />
</p>

//add series to seriesCollection
seriesCollection.Add(charlesSeries);
seriesCollection.Add(jamesSeries);
### and of course it also is
# Powerful

//now just assing this seriesCollection to your chart
//you can use wpf bindings if you need it
myChart.Series = seriesCollection
LiveCharts is not just beauty charts, this example contains 100,000 points, and the chart is being refreshed constantly, we support multiple axes, sections, merged UIelemnts and much more!

//create some labels if necessary
var labels = new string[] {"Jan", "Feb" , "Mar", "Apr", "May", "Jun", "Jul", "Ago", "Sep", "Oct", "Nov", "Dec"};
myChart.AxisX.Add(new Axis { Labels = labels});
```
<p align="center">
<img src="https://lvcharts.net/Content/Images/scrll.gif" />
</p>

### Is live charts what you are looking for? see these interesting examples.
But that is not all, we try to support as many charts as possible, bars, lines, heat maps, gauges, maps:

* **[Live Data](http://lvcharts.net/App/examples/wpf/Constant%20Changes)**: a charts that adds new data each 300ms, DateTime as X Axis.
* **[Observable Points](http://lvcharts.net/App/examples/v1/wpf/IObservableChartPoint)**: notify the chart to update every time a property changes
* **[Simple Bar Chart](http://lvcharts.net/App/examples/wpf/Basic%20Column)**: a simple bar chart.
* *Do not need animations*? ok disable them, performance will be increased also, `Chart.DisableAnimations = true;`
<p align="center">
<img src="https://lvcharts.net/content/images/darkpanel.gif" />
</p>

### Road Map

Expand All @@ -92,17 +70,13 @@ WPF and Winforms, currenlty the library is in the process to become a cross net

###Net Version

.Net 4.0.3 or greater, Windows XP SP3 at least, for more info see [#212](https://github.com/beto-rodriguez/Live-Charts/issues/212)
.Net 4.0 or greater

### Installation

Verify your project uses .Net 4.0.3 or greater, then follow these steps.

* [Wpf](http://lvcharts.net/App/examples/wpf/Install)
* [WinForms](http://lvcharts.net/App/examples/wf/Install)

To verify if you are using a supported .net version, go to SolutionExplorer > Right click on your project > Properties > Application, then verify Taret framework is set at least to .net 4.0.3

### Migrating from older versions?

Please see [https://github.com/beto-rodriguez/Live-Charts/releases](https://github.com/beto-rodriguez/Live-Charts/releases)
Expand All @@ -128,10 +102,6 @@ You can also buy me a beer

The [web site](http://lvcharts.net/App/examples/wpf/start) has a nice set, they are also built in the examples folder up here ^^^^

### High perfomance?

LiveCharts will also handle high performance, it is not ready yet but the current tests allows the library to plot 3,000,000 in 1 second, yes even with aniations.

### Special thanks to

* [JetBrains](https://www.jetbrains.com/), for the resharper license.
Expand Down

0 comments on commit 7065aba

Please sign in to comment.