Skip to content

Commit 536a35a

Browse files
almicalmic
committed
docs(README): Update & simplify README
- Re-ordered some of the sections - Simplified some sections - Reformatted here and there - Added a few emojis, how cute! The goal of this change was to hopefully further reduce the amount of issue support/ question spam. By moving the sections around to show the more important parts higher up, like usage and documentation links, I hope this will make it easier for people to find the documentation.
1 parent 1485cdc commit 536a35a

File tree

2 files changed

+127
-116
lines changed

2 files changed

+127
-116
lines changed

‎README.md‎

Lines changed: 127 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
[![Twitter](https://img.shields.io/badge/Twitter-@PhilippJahoda-blue.svg?style=flat)](http://twitter.com/philippjahoda)
2-
[![Twitter](https://img.shields.io/badge/Twitter-@mpandroidchart-blue.svg?style=flat)](http://twitter.com/mpandroidchart)
3-
[![Android Arsenal](http://img.shields.io/badge/Android%20Arsenal-MPAndroidChart-orange.svg?style=flat)](http://android-arsenal.com/details/1/741)
4-
[![Release](https://img.shields.io/github/release/PhilJay/MPAndroidChart.svg?style=flat)](https://jitpack.io/#PhilJay/MPAndroidChart) [![API](https://img.shields.io/badge/API-8%2B-green.svg?style=flat)](https://android-arsenal.com/api?level=8)
1+
**Remember: _It's all about the looks._**
52

6-
Remember: *It's all about the looks.*
3+
![banner](https://raw.github.com/PhilJay/MPChart/master/design/feature_graphic_smaller.png)
74

8-
![alt tag](https://raw.github.com/PhilJay/MPChart/master/design/feature_graphic.png)
5+
[![Release](https://img.shields.io/github/release/PhilJay/MPAndroidChart.svg?style=flat)](https://jitpack.io/#PhilJay/MPAndroidChart)
6+
[![API](https://img.shields.io/badge/API-8%2B-green.svg?style=flat)](https://android-arsenal.com/api?level=8)
7+
[![Android Arsenal](http://img.shields.io/badge/Android%20Arsenal-MPAndroidChart-orange.svg?style=flat)](http://android-arsenal.com/details/1/741)
8+
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PhilJay/MPAndroidChart?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
9+
[![Twitter](https://img.shields.io/badge/Twitter-@mpandroidchart-blue.svg?style=flat)](http://twitter.com/mpandroidchart)
910

10-
[**MPAndroidChart**](https://github.com/PhilJay/MPAndroidChart) :zap: is a powerful & easy to use chart library for Android. It runs on [API level 8](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) and upwards.
11+
:zap: A powerful & easy to use chart library for Android :zap:
1112

12-
As an additional feature, this library allows cross-platform development between Android and iOS as an iOS version of this library is also available: [**Charts**](https://github.com/danielgindi/Charts) :zap:
13+
[**Charts**](https://github.com/danielgindi/Charts) is the iOS version of this library
1314

14-
[Enterprise Solution 5% Discount Coupon | SciChart](http://store.scichart.com?productTab=Android&CouponCode=MPANDROIDCHART)
15-
-----
15+
## [Enterprise Solution 5% Discount Coupon | SciChart](http://store.scichart.com?productTab=Android&CouponCode=MPANDROIDCHART)
1616

1717
<img align="left" width="190" height="190" style="margin:0px 15px 0px 0px" src="https://raw.github.com/PhilJay/MPChart/master/design/other/left.png">
1818
<img align="right" width="90" height="90" style="margin:0px 15px 0px 0px" src="https://raw.github.com/PhilJay/MPChart/master/design/other/right.png">
@@ -24,177 +24,178 @@ MPAndroidChart is free software, as a result **dynamic & realtime data is not of
2424

2525
All MPAndroidChart users are entitled to a special **discount of 5%** off the <a href="http://store.scichart.com?productTab=Android&CouponCode=MPANDROIDCHART" target="_blank">SciChart store</a>, using the following discount code: **MPANDROIDCHART**
2626

27+
<br/>
2728

29+
## Usage :chart_with_upwards_trend:
2830

29-
<br/>
31+
**Gradle**
3032

33+
- **Project level `build.gradle`**
34+
```gradle
35+
allprojects {
36+
repositories {
37+
maven { url 'https://jitpack.io' }
38+
}
39+
}
40+
```
41+
- **App level `build.gradle`**
42+
```gradle
43+
dependencies {
44+
implementation 'com.github.PhilJay:MPAndroidChart:v3.0.3'
45+
}
46+
```
3147

32-
Donations
33-
-----
48+
**Maven**
3449

35-
**This project needs you!** If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, **feel free to donate**. Your donation is highly appreciated (and I love food, coffee and beer). Thank you!
50+
```xml
51+
<!-- <repositories> section of pom.xml -->
52+
<repository>
53+
<id>jitpack.io</id>
54+
<url>https://jitpack.io</url>
55+
</repository>
3656

37-
**My Bitcoin Wallet** (Bitcoin only)
3857

39-
1G8G6tqQ3oh38BvDH3xq8o6gGVMvBTkcUg
58+
<!-- <dependencies> section of pom.xml -->
59+
<dependency>
60+
<groupId>com.github.PhilJay</groupId>
61+
<artifactId>MPAndroidChart</artifactId>
62+
<version>v3.0.3</version>
63+
</dependency>
64+
```
4065

41-
**My Ethereum Wallet** (Ethereum only)
66+
<br/>
4267

43-
0x04ef098bf9f91871391363e3caf791afa3adc39b
68+
## Documentation :notebook_with_decorative_cover:
4469

45-
**PayPal**
70+
See the [**documentation**](https://github.com/PhilJay/MPAndroidChart/wiki) for examples and general use of MPAndroidChart.
4671

47-
- [**Donate 5 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7G52RA87ED8NY): Thank's for creating this project, here's a coffee (or some beer) for you!
48-
- [**Donate 10 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4C9TPE67F5PUQ): Wow, I am stunned. Let me take you to the movies!
49-
- [**Donate 15 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YKMPTFMVK3JMC): I really appreciate your work, let's grab some lunch!
50-
- [**Donate 25 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=H9JA4QX7UHXCY): That's some awesome stuff you did right there, dinner is on me!
51-
- Or you can also [**choose what you want to donate**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EGBENAC5XBCKS), all donations are awesome!
72+
See the [**javadocs**](https://jitpack.io/com/github/PhilJay/MPAndroidChart/v3.0.3/javadoc/) for more advanced documentation.
5273

74+
<br/>
5375

54-
Spread the word
55-
-----
76+
## Examples :eyes:
77+
Download the [MPAndroidChart Example App](https://play.google.com/store/apps/details?id=com.xxmassdeveloper.mpchartexample) or look at the [source code](https://github.com/PhilJay/MPAndroidChart/tree/master/MPChartExample).
5678

57-
If you like this library, please tell others about it :two_hearts: :two_hearts:
79+
[![ScreenShot](https://github.com/PhilJay/MPAndroidChart/blob/master/design/video_thumbnail.png)](https://www.youtube.com/watch?v=ufaK_Hd6BpI)
5880

59-
<a href="https://twitter.com/intent/tweet?text=Check%20out%20the%20awesome%20MPAndroidChart%20library%20on%20Github:%20https://github.com/PhilJay/MPAndroidChart" target="_blank" title="share to twitter" style="width:100%"><img src="https://github.com/PhilJay/MPAndroidChart/blob/master/design/twitter_icon.png" title="Share on Twitter" width="35" height=35 />
60-
<a href="https://plus.google.com/share?url=https://github.com/PhilJay/MPAndroidChart" target="_blank" title="share to twitter" style="width:100%"><img src="https://github.com/PhilJay/MPAndroidChart/blob/master/design/googleplus_icon.png" title="Share on Google+" width="35" height=35 />
61-
<a href="https://www.facebook.com/sharer/sharer.php?u=https://github.com/PhilJay/MPAndroidChart" target="_blank" title="share to twitter" style="width:100%"><img src="https://github.com/PhilJay/MPAndroidChart/blob/master/design/facebook_icon.png" title="Share on Facebook" width="35" height=35 />
81+
<br/>
6282

63-
- []()Follow me on **Twitter**: [**@PhilippJahoda**](https://twitter.com/PhilippJahoda)
64-
- Look me up on **StackOverflow**: [**Philipp Jahoda**](http://stackoverflow.com/users/1590502/philipp-jahoda)
83+
## Questions & Issues :thinking:
6584

85+
This repository's issue tracker is only for bugs and feature requests. The maintainers ask that you refrain from asking questions about how to use MPAndroidChart through the issue tracker.
6686

67-
Demo
68-
-----
87+
Please read the [**documentation**](https://github.com/PhilJay/MPAndroidChart/wiki) first, then ask all your questions on [stackoverflow.com](https://stackoverflow.com/questions/tagged/mpandroidchart) for the fastest answer.
6988

70-
For a brief overview of the most important features, please download the **PlayStore Demo** [**MPAndroidChart Example.apk**](https://play.google.com/store/apps/details?id=com.xxmassdeveloper.mpchartexample) and try it out. The corresponding code for the demo-application is also included in this repository inside the **MPChartExample folder**.
89+
<br/>
7190

72-
[![ScreenShot](https://github.com/PhilJay/MPAndroidChart/blob/master/design/video_thumbnail.png)](https://www.youtube.com/watch?v=ufaK_Hd6BpI)
91+
## Donations :heart:
7392

74-
Questions & Issues
75-
-----
93+
**This project needs you!** If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, **feel free to donate**. Your donation is highly appreciated (and I love food, coffee and beer). Thank you!
7694

77-
If you are having questions or problems, you should:
95+
**My Bitcoin Wallet** (Bitcoin only)
7896

79-
- **Review your code**. Make absolutely sure that everything is correct on your side.
80-
- Make sure you are using the **latest version** of the library. Check the [**release-section**](https://github.com/PhilJay/MPAndroidChart/releases).
81-
- Study the [**Documentation-Wiki**](https://github.com/PhilJay/MPAndroidChart/wiki) or the [javadocs](https://jitpack.io/com/github/PhilJay/MPAndroidChart/v3.0.3/javadoc/)
82-
- Search or open questions on [**stackoverflow**](https://stackoverflow.com/search?q=mpandroidchart) with the `mpandroidchart` tag
83-
- Search [**known issues**](https://github.com/PhilJay/MPAndroidChart/issues) for your problem (open and closed)
84-
- Create new issues (please :fire: **search known issues before** :fire:, do not create duplicate issues)
85-
- Check this: ["how not to contribute"](https://github.com/PhilJay/MPAndroidChart/wiki/How-not-to-contribute)
86-
87-
Please do not expect answers to your questions if you have not considered all above mentioned approaches in advance.
97+
1G8G6tqQ3oh38BvDH3xq8o6gGVMvBTkcUg
8898

89-
Features
90-
-----
91-
You can have a look at the core features of this libary [**here**](https://github.com/PhilJay/MPAndroidChart/wiki/Core-Features).
92-
93-
Usage
94-
-----
99+
**My Ethereum Wallet** (Ethereum only)
95100

96-
In order to use the library, there are 4 different options:
101+
0x04ef098bf9f91871391363e3caf791afa3adc39b
97102

98-
**1. Gradle dependency** (recommended)
103+
**PayPal**
99104

100-
- Add the following to your project level `build.gradle`:
101-
102-
```gradle
103-
allprojects {
104-
repositories {
105-
maven { url "https://jitpack.io" }
106-
}
107-
}
108-
```
109-
- Add this to your app `build.gradle`:
110-
111-
```gradle
112-
dependencies {
113-
implementation 'com.github.PhilJay:MPAndroidChart:v3.0.3'
114-
}
115-
```
105+
- [**Donate 5 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7G52RA87ED8NY): Thank's for creating this project, here's a coffee (or some beer) for you!
106+
- [**Donate 10 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4C9TPE67F5PUQ): Wow, I am stunned. Let me take you to the movies!
107+
- [**Donate 15 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YKMPTFMVK3JMC): I really appreciate your work, let's grab some lunch!
108+
- [**Donate 25 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=H9JA4QX7UHXCY): That's some awesome stuff you did right there, dinner is on me!
109+
- Or you can also [**choose what you want to donate**](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EGBENAC5XBCKS), all donations are awesome!
116110

117-
**2. Maven**
118-
- Add the following to the `<repositories>` section of your `pom.xml`:
111+
<br/>
119112

120-
```xml
121-
<repository>
122-
<id>jitpack.io</id>
123-
<url>https://jitpack.io</url>
124-
</repository>
125-
```
126-
- Add the following to the `<dependencies>` section of your `pom.xml`:
113+
## Social Media :fire:
127114

128-
```xml
129-
<dependency>
130-
<groupId>com.github.PhilJay</groupId>
131-
<artifactId>MPAndroidChart</artifactId>
132-
<version>v3.0.3</version>
133-
</dependency>
134-
```
135-
136-
**3. clone whole repository** (not recommended)
115+
If you like this library, please tell others about it :two_hearts: :two_hearts:
116+
117+
[![Share on Twitter](https://github.com/PhilJay/MPAndroidChart/blob/master/design/twitter_icon.png)](https://twitter.com/intent/tweet?text=Check%20out%20the%20awesome%20MPAndroidChart%20library%20on%20Github:%20https://github.com/PhilJay/MPAndroidChart)
118+
[![Share on Google+](https://github.com/PhilJay/MPAndroidChart/blob/master/design/googleplus_icon.png)](https://plus.google.com/share?url=https://github.com/PhilJay/MPAndroidChart)
119+
[![Share on Facebook](https://github.com/PhilJay/MPAndroidChart/blob/master/design/facebook_icon.png)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/PhilJay/MPAndroidChart)
137120

138-
Documentation
139-
-----
140-
For a **detailed documentation** :notebook_with_decorative_cover:, please have a look at the [**Wiki**](https://github.com/PhilJay/MPAndroidChart/wiki) or the [javadocs](https://jitpack.io/com/github/PhilJay/MPAndroidChart/v3.0.3/javadoc/).
121+
You can follow the creator on Twitter [**@PhilippJahoda**](https://twitter.com/PhilippJahoda)
141122

142-
Furthermore, you can also rely on the [**MPChartExample**](https://github.com/PhilJay/MPAndroidChart/tree/master/MPChartExample) folder and check out the example code in that project. The corresponding application to the example project is also [**available in the Google PlayStore**](https://play.google.com/store/apps/details?id=com.xxmassdeveloper.mpchartexample).
143-
You can also join others in a discussion on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PhilJay/MPAndroidChart?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
144-
145-
Chart types
146-
-----
123+
Philipp is also on [StackOverflow](http://stackoverflow.com/users/1590502/philipp-jahoda)
124+
125+
<br/>
126+
127+
## More Examples :+1:
128+
129+
<br/>
130+
131+
**LineChart (with legend, simple design)**
147132

148-
- **LineChart (with legend, simple design)**
149133
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/simpledesign_linechart4.png)
150-
- **LineChart (with legend, simple design)**
134+
<br/><br/>
135+
136+
**LineChart (with legend, simple design)**
137+
151138
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/simpledesign_linechart3.png)
139+
<br/><br/>
140+
141+
**LineChart (cubic lines)**
152142

153-
- **LineChart (cubic lines)**
154143
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/cubiclinechart.png)
144+
<br/><br/>
155145

156-
- **LineChart (gradient fill)**
157-
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/line_chart_gradient.png)
146+
**LineChart (gradient fill)**
158147

159-
- **Combined-Chart (bar- and linechart in this case)**
160-
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/combined_chart.png)
148+
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/line_chart_gradient.png)
149+
<br/><br/>
161150

162-
- **BarChart (with legend, simple design)**
151+
**BarChart (with legend, simple design)**
163152

164153
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/simpledesign_barchart3.png)
154+
<br/><br/>
165155

166-
- **BarChart (grouped DataSets)**
156+
**BarChart (grouped DataSets)**
167157

168158
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/groupedbarchart.png)
159+
<br/><br/>
169160

170-
- **Horizontal-BarChart**
161+
**Horizontal-BarChart**
171162

172163
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/horizontal_barchart.png)
164+
<br/><br/>
165+
166+
**Combined-Chart (bar- and linechart in this case)**
173167

168+
![alt tag](https://raw.github.com/PhilJay/MPChart/master/screenshots/combined_chart.png)
169+
<br/><br/>
174170

175-
- **PieChart (with selection, ...)**
171+
**PieChart (with selection, ...)**
176172

177173
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/simpledesign_piechart1.png)
174+
<br/><br/>
178175

179-
- **ScatterChart** (with squares, triangles, circles, ... and more)
176+
**ScatterChart** (with squares, triangles, circles, ... and more)
180177

181178
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/scatterchart.png)
179+
<br/><br/>
182180

183-
- **CandleStickChart** (for financial data)
181+
**CandleStickChart** (for financial data)
184182

185183
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/candlestickchart.png)
184+
<br/><br/>
186185

187-
- **BubbleChart** (area covered by bubbles indicates the yValue)
186+
**BubbleChart** (area covered by bubbles indicates the yValue)
188187

189188
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/bubblechart.png)
189+
<br/><br/>
190190

191-
- **RadarChart** (spider web chart)
191+
**RadarChart** (spider web chart)
192192

193193
![alt tag](https://raw.github.com/PhilJay/MPAndroidChart/master/screenshots/radarchart.png)
194194

195+
<br/>
196+
197+
# License :page_facing_up:
195198

196-
License
197-
=======
198199
Copyright 2018 Philipp Jahoda
199200

200201
Licensed under the Apache License, Version 2.0 (the "License");
@@ -209,4 +210,14 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
209210
See the License for the specific language governing permissions and
210211
limitations under the License.
211212

212-
**Special thanks** to [danielgindi](https://github.com/danielgindi), [mikegr](https://github.com/mikegr), [tony](https://github.com/tonypatino-monoclesociety), [almic](https://github.com/almic) and [jitpack.io](https://github.com/jitpack-io) for their contributions to this project.
213+
<br/>
214+
215+
## Special Thanks :heart:
216+
217+
These people rock!
218+
219+
- [danielgindi](https://github.com/danielgindi) - Daniel Gindi
220+
- [mikegr](https://github.com/mikegr) - Michael Greifeneder
221+
- [tony](https://github.com/tonypatino-monoclesociety) - Tony
222+
- [almic](https://github.com/almic) - Mick A.
223+
- [jitpack.io](https://github.com/jitpack-io) - JitPack.io

‎design/feature_graphic_smaller.png‎

21.9 KB
Loading

0 commit comments

Comments
 (0)