# HG changeset patch
# User Dennis C. M. <dennis@denniscm.com>
# Date 1732093576 0
# Node ID b8549a53d732a033647eb9223a59ebbdeae3db51
# Parent  212573e8b5d458f1486fe433030221ddd017ac07
Add images to readme

diff -r 212573e8b5d4 -r b8549a53d732 .github/1.png
Binary file .github/1.png has changed
diff -r 212573e8b5d4 -r b8549a53d732 README.md
--- a/README.md	Tue Dec 12 08:57:22 2023 +0000
+++ b/README.md	Wed Nov 20 09:06:16 2024 +0000
@@ -1,8 +1,86 @@
 
 # stock-charts
 
-This library has been deprecated. Use the native API -> [Charts](https://developer.apple.com/documentation/charts).
+<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>
+
+This project is now deprecated in favor of the [Apple’s native framework](https://developer.apple.com/documentation/charts). At the time of archiving this project, it has accumulated 98 stars and 11 forks on Github.
+
+StockCharts is a library to create intertactive charts in SwiftUI.
+
+## Installation
+In Xcode go to File -> Swift packages -> Add package dependency
+Copy and paste https://github.com/denniscmartin/stock-charts.git
+I’ve created a demo app using StockCharts called Trades. Check out the code in my Github
+
+## Usage
+
+```swift
+import StockCharts
+``` 
+
+### Line chart
+
+```swift
+let lineChartController = LineChartController(prices: [Double])
+LineChartView(lineChartController: lineChartController)
+```
+
+You can customise the line chart with LineChartController
+
+```swift
+LineChartController(
+    prices: [Double],
+    dates: [String]?, // format: yy-MM-dd
+    hours: [String]?, // has to correspond to dates
+    labelColor: Color,
+    indicatorPointColor: Color,
+    showingIndicatorLineColor: Color,
+    flatTrendLineColor: Color,
+    uptrendLineColor: Color,
+    downtrendLineColor: Color,
+    dragGesture: Bool
+)
+```
 
-A library to display interactive charts in SwiftUI.
+To enable the drag gesture set dragGesture to true in the LineChartController
+
+```swift
+LineChartView(
+    lineChartController:
+        LineChartController(
+            prices: [Double],
+            dragGesture: true
+        )
+)
+```
+
+### Capsule chart
+
+```swift
+CapsuleChartView(percentageOfWidth: CGFloat)
+// percentageOfWidth: must be 0 <= x <= 1
+import SwiftUI
+import StockCharts
 
-<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>
+struct ContentView: View {
+    var body: some View {
+        RoundedRectangle(cornerRadius: 25)
+            .frame(width: 400, height: 120)
+            .foregroundColor(.white)
+            .shadow(color: Color(.gray).opacity(0.15), radius: 10)
+            .overlay(
+                VStack(alignment: .leading) {
+                    Text("Dennis Concepcion")
+                        .font(.title3)
+                        .fontWeight(.semibold)
+
+                    Text("Random guy")
+
+                    CapsuleChartView(percentageOfWidth: 0.6, style: CapsuleChartStyle(capsuleColor: Color.blue))
+                        .padding(.top)
+                }
+                .padding()
+            )
+    }
+}
+```
\ No newline at end of file