Mercurial > public > stock-charts

changeset 12:ef22b1458c15 v0.1-alpha

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 Wed, 28 Apr 2021 18:40:35 +0200
parents 30e0501f74a6
children fdab6510dc46
files README.md
diffstat 1 files changed, 31 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Apr 28 18:40:14 2021 +0200
+++ b/README.md	Wed Apr 28 18:40:35 2021 +0200
@@ -1,4 +1,33 @@
 # SwiftUI Interactive Charts 
-Swift package for displaying responsive interactive charts easily 🎉
+Swift package for displaying interactive stock charts easily 🎉
+
+## Features
+- Interactive line chart
+- Light weight
+- Easy to use
+
+## Requirements
+- iOS 14+
+- Swift 5+
+
+## Instalation
+- In Xcode go to `File` -> `Swift packages` -> `Add package dependency`
+- Copy and paste `https://github.com/denniscm190/SwiftUI-InteractiveCharts.git`
 
-## Currently in development, come back later 🚧
+## Usage
+Import the package in the file you want to use it: `import InteractiveCharts`
+
+### Line chart
+```swift
+ChartView(data: [Double], dates: [String]?, hours: [String]?)
+```
+
+#### Arguments
+```swift
+data: [120.3, 121.0, 132.4, ...]
+dates: ["yyyy-MM-dd", "2021-01-01", "2021-01-02", ...]
+hours: ["10:20", "10:21", "10:22", ...]  // It could be any format
+```
+
+
+