From 0bea3bbb78db0347898e4991c3691410d9c14abc Mon Sep 17 00:00:00 2001 From: Prateeksha Singh Date: Sat, 4 Nov 2017 23:10:36 +0530 Subject: [PATCH] Update docs on importing module --- README.md | 9 ++++++++- docs/index.html | 8 +++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dbf1e9f..41594b2 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,12 @@ ```console $ npm install frappe-charts ``` + + and include in your project: + ```js + import Chart from "frappe-charts" + ``` + * ...or include within your HTML ```html @@ -78,4 +84,5 @@ If you want to contribute: This repository has been released under the [MIT License](LICENSE) ------------------ -Made with ♥ by [pratu16x7](https://github.com/pratu16x7). Project maintained by [frappe](https://github.com/frappe) +Made with ♥ by [pratu16x7](https://github.com/pratu16x7). Awesome logo by [raghukamath](https://github.com/raghukamath). +Project maintained by [frappe](https://github.com/frappe). diff --git a/docs/index.html b/docs/index.html index d8cf020..8e2ece2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -49,9 +49,11 @@ Create a chart

Install

- 
  npm install frappe-charts
-

Include it in your HTML

- 
  <script src="frappe-charts.min.js" />
+ 
  npm install frappe-charts
+

And include it in your project

+ 
  import Chart from "frappe-charts"
+

... or include it directly in your HTML

+ 
  <script src="https://unpkg.com/frappe-charts@0.0.3/dist/frappe-charts.min.iife.js" />

Make a new Chart

  <!--HTML-->
   <div id="chart"></div>