Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivnsch authored Mar 11, 2019
1 parent 9e80cc9 commit fbd30b0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ iOS 7+
![ScreenShot](Screenshots/IMG_0041.jpeg)


## 🛠 Installation
## Installation

### CocoaPods

Expand Down Expand Up @@ -107,15 +107,15 @@ Swift 2.3 (not actively maintained):
github "i-schuetz/SwiftCharts" ~> 0.4
```

## 🤝 Contribute
## Contribute

Contributions are highly appreciated! To submit one:

1. Fork
2. Commit changes to a branch in your fork
3. Push your code and make a pull request

## 🏎️ Quick start
## Quick start

Multiline chart:

Expand Down Expand Up @@ -171,7 +171,7 @@ self.view.addSubview(chart.view)
self.chart = chart
```

## 👩‍🏫 Concept:
## Concept:

- Layer architecture, which makes it extremely easy to customize charts, create new types, combine existing ones and add interactive elements.

Expand Down Expand Up @@ -254,17 +254,17 @@ Layers decide how to present their data - this can be done adding subviews, (CA)

View based layers will use a generator function to generate chart point views. This function receives the complete state of each chartpoint (model data, screen location) and produces an UIView, allowing any type of customization.

### 🐤 Hello world:
### Hello world:

There's a [hello world](Examples/Examples/HelloWorld.swift) included in the examples, similar to the above code, with a bit more explanations. Change some properties of the generated views, copy paste the chartPointsLineLayer used in the snippet above, and pass it to the chart's layers, to display a line behind the views, and you have already mastered the main concepts!

#### ⚠️ Important!
#### Important!

* Don't forget to always keep a strong reference to the chart instance or it will be released, which leads to axis & labels not showing.

* If you have a lot of axis labels in your chart it may be necessary to do the calculation of the coordinate space in the background, to avoid possible delays which are noticeable during transitions or scrolling. See ScrollExample or MultipleAxesExample example for this.

## Tasks
## Tasks

SwiftCharts has got now some [projects](https://github.com/i-schuetz/SwiftCharts/projects) to plan features and improvements. Feel free to grab any of these topics even if it's just to add feedback. You can open an issue for this. Other options like opening a Slack channel are possible.

Expand Down

0 comments on commit fbd30b0

Please sign in to comment.