Mercurial > public > stock-charts

annotate README.md @ 77:3d4c995845fd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README.md
author Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
date Sat, 15 May 2021 20:04:24 +0200
parents e16e6bdaa31d
children 9aad15056838
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
4057e402b0bf Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 45
diff changeset
1 ![Build Status](https://github.com/denniscm190/StockCharts/actions/workflows/swift.yml/badge.svg)
45
26a91d7ce85e Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 36
diff changeset
2
23
cf68e93882b4 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 22
diff changeset
3 # SwiftUI Stock Charts
77
3d4c995845fd Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 60
diff changeset
4 Display interactive stock charts easily 🎉
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
5
58
0dde4e54bb7b Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 54
diff changeset
6 <img width="374" alt="View1-Screenshot" src="https://user-images.githubusercontent.com/66180929/116898466-b207d000-ac36-11eb-8fb6-0a4f229307db.png">
0dde4e54bb7b Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 54
diff changeset
7
34
b7a62f863948 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 23
diff changeset
8
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
9 ## Features
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
10 - Interactive line chart
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
11 - Light weight
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
12 - Easy to use
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
13
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
14 ## Requirements
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
15 - iOS 14+
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
16 - Swift 5+
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
17
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
18 ## Instalation
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
19 - In Xcode go to `File` -> `Swift packages` -> `Add package dependency`
22
5c9f74baee88 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 21
diff changeset
20 - Copy and paste `https://github.com/denniscm190/StockCharts.git`
6
9802bdd5c7f3 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 0
diff changeset
21
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
22 ## Usage
36
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
23 ```swift
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
24 import StockCharts
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
25 ```
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
26
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
27 ### Line chart
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
28 ```swift
60
e16e6bdaa31d Add dragGesture argument
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 59
diff changeset
29 LineChartView(data: [Double], dates: [String]?, hours: [String]?, dragGesture: Bool?)
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
30 ```
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
31
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
32 #### Arguments
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
33 ```swift
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
34 data: [120.3, 121.0, 132.4, ...]
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
35 dates: ["yyyy-MM-dd", "2021-01-01", "2021-01-02", ...]
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
36 hours: ["10:20", "10:21", "10:22", ...] // It could be any format
60
e16e6bdaa31d Add dragGesture argument
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 59
diff changeset
37 dragGesture: false // By default is true
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
38 ```
59
e54c96a5c652 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 58
diff changeset
39 <img width="374" alt="LineChartVideo" src="https://user-images.githubusercontent.com/66180929/116899623-137c6e80-ac38-11eb-8ec0-e678aea54062.gif">