update readme

iifksp · Sep 23, 2018 · 742a0ee · 742a0ee
1 parent 80ffd42
commit 742a0ee
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/.npmignore b/.npmignore
@@ -2,3 +2,4 @@ src
 demo
 .babelrc
 webpack.config.js
+.idea
diff --git a/README.md b/README.md
@@ -1,2 +1,28 @@
 # react-mini-chart
-react mini line chart
+Simple react mini line chart using SVG
+
+## Install
+```
+npm install react-mini-chart
+```
+
+## Usage
+
+default
+```
+<MiniChart dataSet={[0, -20, 343, 49.3, -100, 200, 78]}/>
+```
+
+custom
+```
+<MiniChart
+  strokeColor="#FF6600"
+  activePointColor="#FF6600"
+  activePointRadius={8}
+  strokeWidth={5}
+  labelFontSize={50}
+  width={500}
+  height={100}
+  dataSet={[0, -20, 343, 49.3, -100, 200, 78]}
+/>
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-mini-chart",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "react mini line chart",
   "main": "build/index.js",
   "scripts": {
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,4 @@ src @@
     demo
     .babelrc
     webpack.config.js
+    .idea