annotate README.md @ 114:c43f064cde3f

Updated .gitignore
author Dennis C. M. <dennis@denniscm.com>
date Thu, 05 Aug 2021 15:44:54 +0100
parents 0c0d38dca6d8
children 7cdc06d6a9cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
79
1771c58c4abd Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 78
diff changeset
1 <a href="https://www.producthunt.com/posts/stockcharts-for-swiftui?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-stockcharts-for-swiftui" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=295975&theme=dark" alt="StockCharts for SwiftUI - Display interactive stock charts easily 🎉 | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
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
84
df511f7ca8fa Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 79
diff changeset
4 ![Build Status](https://github.com/denniscm190/StockCharts/actions/workflows/swift.yml/badge.svg)
df511f7ca8fa Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 79
diff changeset
5 [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdenniscm190%2FStockCharts%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/denniscm190/StockCharts)
df511f7ca8fa Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 79
diff changeset
6 [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fdenniscm190%2FStockCharts%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/denniscm190/StockCharts)
77
3d4c995845fd Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 60
diff changeset
7 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
8
58
0dde4e54bb7b Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 54
diff changeset
9 <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
10
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
11 ## Instalation
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
12 - 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
13 - Copy and paste `https://github.com/denniscm190/StockCharts.git`
6
9802bdd5c7f3 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 0
diff changeset
14
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
15 ## Usage
36
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
16 ```swift
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
17 import StockCharts
a4c6cc874499 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 35
diff changeset
18 ```
12
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
19
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
20 ### Line chart
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
21 ```swift
60
e16e6bdaa31d Add dragGesture argument
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 59
diff changeset
22 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
23 ```
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
24
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
25 ```swift
ef22b1458c15 Update README.md
Dennis Concepción Martín <66180929+denniscm190@users.noreply.github.com>
parents: 6
diff changeset
26 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
27 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
28 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
29 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
30 ```
59
e54c96a5c652 Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 58
diff changeset
31 <img width="374" alt="LineChartVideo" src="https://user-images.githubusercontent.com/66180929/116899623-137c6e80-ac38-11eb-8ec0-e678aea54062.gif">
92
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
32
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
33 ### Capsule chart
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
34 ```swift
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
35 CapsuleChartView(percentageOfWidth: CGFloat)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
36 // percentageOfWidth: must be 0 <= x <= 1
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
37 ```
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
38
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
39 #### Example
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
40 ```swift
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
41 import SwiftUI
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
42 import StockCharts
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
43
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
44 struct ContentView: View {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
45 var body: some View {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
46 RoundedRectangle(cornerRadius: 25)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
47 .frame(width: 400, height: 120)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
48 .foregroundColor(.white)
106
0c0d38dca6d8 Change colours to native swiftUI
Dennis Concepción Martín <dennisconcepcionmartin@gmail.com>
parents: 92
diff changeset
49 .shadow(color: Color(,.gray).opacity(0.15), radius: 10)
92
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
50 .overlay(
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
51 VStack(alignment: .leading) {
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
52 Text("Dennis Concepcion")
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
53 .font(.title3)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
54 .fontWeight(.semibold)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
55
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
56 Text("Random guy")
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
57
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
58 CapsuleChartView(percentageOfWidth: 0.6)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
59 .padding(.top)
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
60 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
61 .padding()
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
62 )
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
63 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
64 }
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
65 ```
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
66
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
67 <img width="328" alt="CapsuleChart" src="https://user-images.githubusercontent.com/66180929/120899384-c2450d80-c62f-11eb-9a56-5a03e97441d2.png">
5b9859e47d3c Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 88
diff changeset
68