Edit documentation

rickypid · Apr 11, 2021 · 897d922 · 897d922
1 parent adb8bb8
commit 897d922
Show file tree

Hide file tree

Showing 6 changed files with 342 additions and 99 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## [0.1.1-alpha] - 2021-04-11
+
+* Optimization documentation release.
+
 ## [0.1.0-alpha] - 2021-04-11
 
 * Initial Open Source release.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Pub Package](https://img.shields.io/pub/v/flutter_bargraph.svg?style=flat-square)](https://pub.dartlang.org/packages/flutter_bargraph) [![Package Issue](https://img.shields.io/github/issues/rickypid/flutter_bargraph)](https://github.com/rickypid/flutter_bargraph/issues)
 ![Package License](https://img.shields.io/github/license/rickypid/flutter_bargraph)
 
-Flutter Single value bar graph viewer with indicators
+Bar Graph Indicator for Flutter. It graphically displays the current value on a bar graph and manages its animation when the value changes. you can customize the orientation and direction of the bar.
 
 | ![Image](https://github.com/rickypid/flutter_bargraph/blob/7f5bde4ebc40899079800127c815e01beac3abcb/doc/.media/example.gif?raw=true) |
 | :------------: |
@@ -52,7 +52,7 @@ BarGraph(
 #### Style
 
 * `orientation` is the scale orientation, default vertical from bottom.
-* `indicatorStyle` is the scale indicators style, default BOTH, left and right.
+* `indicatorStyle` is the scale indicators style, default BOTH, left and right visible.
 * `indicatorSpacing` is the scale indicators spacing, default SPACE_AROUND, alternative SPACE_BETWEEN.
 
 #### Colors

diff --git a/exmple/lib/main.dart b/exmple/lib/main.dart
@@ -22,17 +22,19 @@ class MyApp extends StatelessWidget {
 class MyHomePage extends StatefulWidget {
   MyHomePage({Key key, this.title}) : super(key: key);
   final String title;
+
   @override
   _MyHomePageState createState() => _MyHomePageState();
 }
 
 class _MyHomePageState extends State<MyHomePage> {
-
   double _currentSliderValue = 5;
+
   @override
   void initState() {
     super.initState();
   }
+
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -48,25 +50,23 @@ class _MyHomePageState extends State<MyHomePage> {
                 children: [
                   Expanded(
                       child: BarGraph(
-                        min: 0,
-                        max: 100,
-                        divisions: 4,
-                        value: _currentSliderValue,
-                        barColor: Theme.of(context).accentColor,
-                        orientation: BarGraphOrientation.HORIZONTAL_FROM_LEFT,
-                      )
-                  ),
+                    min: 0,
+                    max: 100,
+                    divisions: 4,
+                    value: _currentSliderValue,
+                    barColor: Theme.of(context).accentColor,
+                    orientation: BarGraphOrientation.HORIZONTAL_FROM_LEFT,
+                  )),
                   Expanded(
                       child: BarGraph(
-                        min: 0,
-                        max: 100,
-                        divisions: 5,
-                        value: _currentSliderValue,
-                        barColor: Theme.of(context).accentColor,
-                        orientation: BarGraphOrientation.VERTICAL_FROM_BOTTOM,
-                        indicatorSpacing: BarGraphIndicatorSpacing.SPACE_BETWEEN,
-                      )
-                  ),
+                    min: 0,
+                    max: 100,
+                    divisions: 5,
+                    value: _currentSliderValue,
+                    barColor: Theme.of(context).accentColor,
+                    orientation: BarGraphOrientation.VERTICAL_FROM_BOTTOM,
+                    indicatorSpacing: BarGraphIndicatorSpacing.SPACE_BETWEEN,
+                  )),
                 ],
               ),
             ),