Updating readme to demonstrate the new example slider

danpanaite · Aug 11, 2019 · 7123398 · 7123398
1 parent 948b7d5
commit 7123398
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## [0.1.1] - 2019-08-10
+
+* Updating the example to showcase the flexibility of the chart.
+
 ## [0.1.0] - 2019-08-10
 
 * Adding basic animation on widget update.

diff --git a/README.md b/README.md
@@ -1,13 +1,12 @@
 # flutter_radar_chart
 
-Radar chart for Flutter inspired by The Python Graph Gallery (https://python-graph-gallery.com/radar-chart/).
+Animated radar chart for Flutter inspired by The Python Graph Gallery (https://python-graph-gallery.com/radar-chart/).
 
 Follow the instructions on pub to install this package.
 
 ## Example
 
-![screenshot](example/screenshots/light_mode_small.jpg)
-![screenshot](example/screenshots/dark_mode_small.jpg)
+![screenshot](example/screenshots/example_small.gif)
 
 # Usage
 
@@ -26,11 +25,16 @@ RadarChart.light(
 ```
 A full example (as seen in the screenshots) can be found in example/lib/main.dart
 
-# Animations!
+# Customizability
+
+Most of the customizability of the graph is a work in progress, but here's some of the features of the chart:
 
-WIP, but trying to add some life to the chart. Animation is currently triggered whenever the widget is updated (`didUpdateWidget`). Screenshot was captured with an emulator, so the animation is a bit janky.
+* **Animations!** Trying to add some life to the chart. Animation is currently triggered whenever the widget is updated (`didUpdateWidget`). Animations are currently enabled by default.
+* **Number of features:** As shown in the example, the radar chart will adjust to the number of given variables. More work is needed to ensure the chart doesn't explode when given invalid data.
+* **Reverse axis:** Reverses the axis range so that the min value starts at the graph outline.
+* **Dark mode:** Simple factory that showcases the color customizability of the chart.
 
-![screenshot](example/screenshots/animation.gif)
+![screenshot](example/screenshots/dark_mode_small.jpg)
 
 # Future Work Ideas
 

diff --git a/example/README.md b/example/README.md
@@ -1,16 +1,4 @@
-# example
+# Example of flutter_radar_chart
 
-A new Flutter project.
+![screenshot](screenshots/example_small.gif)
 
-## Getting Started
-
-This project is a starting point for a Flutter application.
-
-A few resources to get you started if this is your first Flutter project:
-
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
-
-For help getting started with Flutter, view our
-[online documentation](https://flutter.dev/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.1.0"
+    version: "0.1.1"
   flutter_test:
     dependency: "direct dev"
     description: flutter

diff --git a/example/screenshots/animation.gif b/example/screenshots/animation.gif
diff --git a/example/screenshots/dark_mode.jpg b/example/screenshots/dark_mode.jpg
diff --git a/example/screenshots/example_small.gif b/example/screenshots/example_small.gif
diff --git a/example/screenshots/light_mode.jpg b/example/screenshots/light_mode.jpg
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: flutter_radar_chart
 description: Basic radar chart for Flutter. This chart is intended to work out of the box, adjusting itself to the given data. The design of the chart was inspired by the Python Graph Gallery.
-version: 0.1.0
+version: 0.1.1
 author: Dan Panaite <[email protected]>
 homepage: https://github.com/danpanaite/flutter_radar_chart