1.0.4

dJani97 · Jan 1, 2020 · 2d9eb67 · 2d9eb67
1 parent cc0eab9
commit 2d9eb67
Show file tree

Hide file tree

Showing 6 changed files with 149 additions and 63 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,17 +2,36 @@
 
 **2019-12-18**
 
-* Initial beta version.
+- Initial beta version.
 
 ## 1.0.0
 
 **2019-12-20**
 
-* First formal version.
-* Echarts version 4.5.0
+- First formal version.
+- Echarts version 4.5.0
 
 ## 1.0.1
 
 **2019-12-24**
 
-* Add blog link and installing in README.
+- Add blog link and installing in README.
+
+## 1.0.2
+
+**2020-01-01**
+
+- Update README.
+- Update license year.
+
+## 1.0.3
+
+**2020-01-01**
+
+- Fix README.
+
+## 1.0.4
+
+**2020-01-01**
+
+- Fix README badge.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2018, LIN Chen
+Copyright (c) 2018-2020, LIN Chen
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -246,3 +246,25 @@ The following files embed [d3.js](https://github.com/d3/d3) BSD 3-Clause:
     `/src/util/number.js`,
     `/src/scale/Time.js`,
 See `/licenses/LICENSE-d3` for details of the license.
+
+MIT License
+
+Copyright (c) 2017-2019 chenjiandongx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,12 +1,40 @@
+[中文](https://github.com/entronad/flutter_echarts/blob/master/README_CN.md) 
+
 <p align="center">
-<img src="https://github.com/entronad/flutter_echarts/blob/master/doc/log.png" width=300 height=300 />
+<img src="https://raw.githubusercontent.com/entronad/flutter_echarts/master/doc/logo.png" />
 </p>
 
-A Flutter widget to use [Echarts]((https://github.com/apache/incubator-echarts)) in a reactive way.
-
-[中文](https://github.com/entronad/flutter_echarts/blob/master/README_CN.md)
-
-[Developing blog](https://medium.com/@entronad/reactive-echarts-flutter-widget-fedab7f3c52f)
+[![pub](https://img.shields.io/pub/v/flutter_echarts.svg)](https://pub.dev/packages/flutter_echarts)
+[![awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/ecomfe/awesome-echarts#dart)
+
+*A Flutter widget to use [Echarts]((https://github.com/apache/incubator-echarts)) in a reactive way.* 
+
+<div align="center">
+<img src="https://user-images.githubusercontent.com/19553554/52197440-843a5200-289a-11e9-8601-3ce8d945b04a.gif" width="33%" height="33%" alt="bar"/>
+<img src="https://user-images.githubusercontent.com/19553554/52360729-ad640980-2a77-11e9-84e2-feff7e11aea5.gif" width="33%" height="33%" alt="boxplot"/>
+<img src="https://user-images.githubusercontent.com/19553554/52535290-4b611800-2d87-11e9-8bf2-b43a54a3bda8.png" width="33%" height="33%" alt="effectScatter"/>
+<img src="https://user-images.githubusercontent.com/19553554/52332816-ac5eb800-2a36-11e9-8227-3538976f447d.gif" width="33%" height="33%" alt="funnel"/>
+<img src="https://user-images.githubusercontent.com/19553554/52332988-0b243180-2a37-11e9-9db8-eb6b8c86a0de.png" width="33%" height="33%" alt="gague"/>
+<img src="https://user-images.githubusercontent.com/19553554/52344575-133f9980-2a56-11e9-93e0-568e484936ce.gif" width="33%" height="33%" alt="geo"/>
+<img src="https://user-images.githubusercontent.com/19553554/52727805-f7f20280-2ff0-11e9-91ab-cd99848e3127.gif" width="33%" height="33%" alt="graph"/>
+<img src="https://user-images.githubusercontent.com/19553554/52345115-6534ef00-2a57-11e9-80cd-9cbfed252139.gif" width="33%" height="33%" alt="heatmap"/>
+<img src="https://user-images.githubusercontent.com/19553554/52345490-4a16af00-2a58-11e9-9b43-7bbc86aa05b6.gif" width="33%" height="33%" alt="kline"/>
+<img src="https://user-images.githubusercontent.com/19553554/52346064-b7770f80-2a59-11e9-9e03-6dae3a8c637d.gif" width="33%" height="33%" alt="line"/>
+<img src="https://user-images.githubusercontent.com/19553554/52347117-248ba480-2a5c-11e9-8402-5a94054dca50.gif" width="33%" height="33%" alt="liquid"/>
+<img src="https://user-images.githubusercontent.com/19553554/52347915-0a52c600-2a5e-11e9-8039-41268238576c.gif" width="33%" height="33%" alt="map"/>
+<img src="https://user-images.githubusercontent.com/19553554/52535013-e48e2f80-2d83-11e9-8886-ac0d2122d6af.png" width="33%" height="33%" alt="parallel"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348202-bb596080-2a5e-11e9-84a7-60732be0743a.gif" width="33%" height="33%" alt="pie"/>
+<img src="https://user-images.githubusercontent.com/19553554/52533994-932b7380-2d76-11e9-93b4-0de3132eb941.gif" width="33%" height="33%" alt="radar"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348431-420e3d80-2a5f-11e9-8cab-7b415592dc77.gif" width="33%" height="33%" alt="scatter"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348737-01fb8a80-2a60-11e9-94ac-dacbd7b58811.png" width="33%" height="33%" alt="wordCloud"/>
+<img src="https://user-images.githubusercontent.com/19553554/52433989-4f075b80-2b49-11e9-9979-ef32c2d17c96.gif" width="33%" height="33%" alt="bar3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52464826-4baab900-2bb7-11e9-8299-776f5ee43670.gif" width="33%" height="33%" alt="line3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52802261-8d0cfe00-30ba-11e9-8ae7-ae0773770a59.gif" width="33%" height="33%" alt="sankey"/>
+<img src="https://user-images.githubusercontent.com/19553554/52464647-aee81b80-2bb6-11e9-864e-c544392e523a.gif" width="33%" height="33%" alt="scatter3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52465183-a55fb300-2bb8-11e9-8c10-4519c4e3f758.gif" width="33%" height="33%" alt="surface3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52798246-7ebae400-30b2-11e9-8489-6c10339c3429.gif" width="33%" height="33%" alt="themeRiver"/>
+<img src="https://user-images.githubusercontent.com/19553554/52349544-c2ce3900-2a61-11e9-82af-28aaaaae0d67.gif" width="33%" height="33%" alt="overlap"/>
+</div>
 
 # Features
 
@@ -22,43 +50,33 @@ The `onMessage` and `extraScript` properties provide a way to set event communic
 
 Echarts has a lot of [extensions](https://echarts.apache.org/en/download-extension.html) . the `extensions` property allows you to inject the extension scripts as raw strings. In this way, you can copy these scripts to your source code, without concerning about the confusing assets dirs.
 
-# Installing
+# Blog
 
-**1. Depend on it**
+[Developing blog](https://medium.com/@entronad/reactive-echarts-flutter-widget-fedab7f3c52f)
+
+# Installing
 
 Add this to your package's pubspec.yaml file:
 
 ```yaml
 dependencies:
-  flutter_echarts: ^1.0.1
+  flutter_echarts: #latest version
 ```
 
-**2. Install it**
-
-You can install packages from the command line:
-
-with Flutter:
-
-```shell
-$ flutter pub get
-```
-
-Alternatively, your editor might support `flutter pub get`. Check the docs for your editor to learn more.
-
-**3. Import it**
-
 Now in your Dart code, you can use:
 
 ```dart
 import 'package:flutter_echarts/flutter_echarts.dart';  
 ```
 
-# Usage
+Details see [pub.dev](https://pub.dev/packages/flutter_echarts#-installing-tab-) .
 
-*Before using flutter_echarts, make sure you know how to use  [Echarts]((https://github.com/apache/incubator-echarts)) .*
+# Usage
 
 The flutter_echarts itself is very simple to use, just like a common statelessWidget:
 
+> Details about the option is in the [Echarts docs](https://echarts.apache.org/en/option.html#title) or [Echarts examples](https://echarts.apache.org/examples/en/index.html) 
+
 ```
 Container(
   child: Echarts(
@@ -125,9 +143,9 @@ The JavaScript which will execute after the `Echarts.init()` and before any `cha
 ```
 extraScript: '''
   chart.on('click', (params) => {
-  if(params.componentType === 'series') {
-  	Messager.postMessage('anything');
-  }
+    if(params.componentType === 'series') {
+  	  Messager.postMessage('anything');
+    }
   });
 ''',
 ```
@@ -156,4 +174,6 @@ const liquidPlugin = r'''
 
 ---
 
-If you have any suggestions or demands, please give an [issue](https://github.com/entronad/flutter_echarts/issues) .
+If you have any suggestions or demands, please give an [issue](https://github.com/entronad/flutter_echarts/issues) .
+
+*The gallery GIF is from [chenjiandongx](https://github.com/chenjiandongx)*
diff --git a/README_CN.md b/README_CN.md
@@ -1,9 +1,42 @@
-# flutter_echarts
-
-响应式的 [Echarts]((https://github.com/apache/incubator-echarts))  Flutter 组件.
-
-[English](https://github.com/entronad/flutter_echarts/blob/master/README.md)
-
+[English](https://github.com/entronad/flutter_echarts/blob/master/README.md) 
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/entronad/flutter_echarts/master/doc/logo.png" />
+</p>
+
+[![pub](https://img.shields.io/pub/v/flutter_echarts.svg)](https://pub.dev/packages/flutter_echarts)
+[![awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/ecomfe/awesome-echarts#dart)
+
+*响应式的 [Echarts]((https://github.com/apache/incubator-echarts))  Flutter 组件.* 
+
+<div align="center">
+<img src="https://user-images.githubusercontent.com/19553554/52197440-843a5200-289a-11e9-8601-3ce8d945b04a.gif" width="33%" height="33%" alt="bar"/>
+<img src="https://user-images.githubusercontent.com/19553554/52360729-ad640980-2a77-11e9-84e2-feff7e11aea5.gif" width="33%" height="33%" alt="boxplot"/>
+<img src="https://user-images.githubusercontent.com/19553554/52535290-4b611800-2d87-11e9-8bf2-b43a54a3bda8.png" width="33%" height="33%" alt="effectScatter"/>
+<img src="https://user-images.githubusercontent.com/19553554/52332816-ac5eb800-2a36-11e9-8227-3538976f447d.gif" width="33%" height="33%" alt="funnel"/>
+<img src="https://user-images.githubusercontent.com/19553554/52332988-0b243180-2a37-11e9-9db8-eb6b8c86a0de.png" width="33%" height="33%" alt="gague"/>
+<img src="https://user-images.githubusercontent.com/19553554/52344575-133f9980-2a56-11e9-93e0-568e484936ce.gif" width="33%" height="33%" alt="geo"/>
+<img src="https://user-images.githubusercontent.com/19553554/52727805-f7f20280-2ff0-11e9-91ab-cd99848e3127.gif" width="33%" height="33%" alt="graph"/>
+<img src="https://user-images.githubusercontent.com/19553554/52345115-6534ef00-2a57-11e9-80cd-9cbfed252139.gif" width="33%" height="33%" alt="heatmap"/>
+<img src="https://user-images.githubusercontent.com/19553554/52345490-4a16af00-2a58-11e9-9b43-7bbc86aa05b6.gif" width="33%" height="33%" alt="kline"/>
+<img src="https://user-images.githubusercontent.com/19553554/52346064-b7770f80-2a59-11e9-9e03-6dae3a8c637d.gif" width="33%" height="33%" alt="line"/>
+<img src="https://user-images.githubusercontent.com/19553554/52347117-248ba480-2a5c-11e9-8402-5a94054dca50.gif" width="33%" height="33%" alt="liquid"/>
+<img src="https://user-images.githubusercontent.com/19553554/52347915-0a52c600-2a5e-11e9-8039-41268238576c.gif" width="33%" height="33%" alt="map"/>
+<img src="https://user-images.githubusercontent.com/19553554/52535013-e48e2f80-2d83-11e9-8886-ac0d2122d6af.png" width="33%" height="33%" alt="parallel"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348202-bb596080-2a5e-11e9-84a7-60732be0743a.gif" width="33%" height="33%" alt="pie"/>
+<img src="https://user-images.githubusercontent.com/19553554/52533994-932b7380-2d76-11e9-93b4-0de3132eb941.gif" width="33%" height="33%" alt="radar"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348431-420e3d80-2a5f-11e9-8cab-7b415592dc77.gif" width="33%" height="33%" alt="scatter"/>
+<img src="https://user-images.githubusercontent.com/19553554/52348737-01fb8a80-2a60-11e9-94ac-dacbd7b58811.png" width="33%" height="33%" alt="wordCloud"/>
+<img src="https://user-images.githubusercontent.com/19553554/52433989-4f075b80-2b49-11e9-9979-ef32c2d17c96.gif" width="33%" height="33%" alt="bar3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52464826-4baab900-2bb7-11e9-8299-776f5ee43670.gif" width="33%" height="33%" alt="line3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52802261-8d0cfe00-30ba-11e9-8ae7-ae0773770a59.gif" width="33%" height="33%" alt="sankey"/>
+<img src="https://user-images.githubusercontent.com/19553554/52464647-aee81b80-2bb6-11e9-864e-c544392e523a.gif" width="33%" height="33%" alt="scatter3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52465183-a55fb300-2bb8-11e9-8c10-4519c4e3f758.gif" width="33%" height="33%" alt="surface3D"/>
+<img src="https://user-images.githubusercontent.com/19553554/52798246-7ebae400-30b2-11e9-8489-6c10339c3429.gif" width="33%" height="33%" alt="themeRiver"/>
+<img src="https://user-images.githubusercontent.com/19553554/52349544-c2ce3900-2a61-11e9-82af-28aaaaae0d67.gif" width="33%" height="33%" alt="overlap"/>
+</div>
+
+# 博客
 [开发博客](https://zhuanlan.zhihu.com/p/99034738)
 
 # 特点
@@ -22,37 +55,27 @@ Echarts 有很多 [扩展](https://echarts.apache.org/en/download-extension.html
 
 # 安装
 
-**1. 设置依赖**
-
 在 pbuspec.yaml 文件中添加：
 
 ```
 dependencies:
-  flutter_echarts: ^1.0.1
-```
-
-**2. 安装**
-
-编辑器会自动执行安装，或在命令行中执行
-
-```
-$ flutter pub get
+  flutter_echarts: #最新版本
 ```
 
-**3. 引入代码**
-
-在要使用的文件中：
+在需要使用的文件中：
 
 ```
 import 'package:flutter_echarts/flutter_echarts.dart';  
 ```
 
-# 使用
+详见 [pub.dev](https://pub.dev/packages/flutter_echarts#-installing-tab-) .
 
-*使用 flutter_echarts 之前，确保你已经会使用  [Echarts]((https://github.com/apache/incubator-echarts)) 。*
+# 使用
 
 flutter_echarts 使用起来很简单，就像在使用普通的 statelessWidget ：
 
+> option 的具体设置请见 [Echarts 文档](https://echarts.apache.org/cn/option.html#title) 或 [Echarts 示例](https://echarts.apache.org/examples/cn/index.html) 。
+
 ```
 Container(
   child: Echarts(
@@ -119,9 +142,9 @@ Echarts(
 ```
 extraScript: '''
   chart.on('click', (params) => {
-  if(params.componentType === 'series') {
-  	Messager.postMessage('anything');
-  }
+    if(params.componentType === 'series') {
+  	  Messager.postMessage('anything');
+    }
   });
 ''',
 ```
@@ -150,4 +173,6 @@ const liquidPlugin = r'''
 
 ---
 
-如果有建议或要求，请发起 [issue](https://github.com/entronad/flutter_echarts/issues) 。
+如果有建议或要求，请发起 [issue](https://github.com/entronad/flutter_echarts/issues) 。
+
+*示例 GIF 来自 [chenjiandongx](https://github.com/chenjiandongx)*
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -75,7 +75,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.1"
+    version: "1.0.4"
   flutter_test:
     dependency: "direct dev"
     description: flutter

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: flutter_echarts
-description: A Flutter widget to use Echarts in a reactive way. Features are Reactive Updating, Two Way Communication, Configurable Extensions.
-version: 1.0.1
+description: A Flutter widget to use Echarts in a reactive way which builds awesome data visualization charts. Features are Reactive Updating, Two Way Communication, Configurable Extensions.
+version: 1.0.4
 author: LIN Chen <[email protected]>
 homepage: https://github.com/entronad/flutter_echarts