v0.0.1

iamSahdeep · Mar 1, 2020 · 20bc4ff · 20bc4ff
1 parent 04f94d8
commit 20bc4ff
Show file tree

Hide file tree

Showing 8 changed files with 4,315 additions and 4,271 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 #ChangeLog
 
 
-## 1.0.0
-* Liquid Button
+## 0.0.1
+* Liquid Button - First Release
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 </p>
 
 <p align="center">
-  Hi, introducing Liquid Button for Flutter. It supports Web and Mobile, not tested on Ios. Inspired by <a href="https://codepen.io/electerious/pen/gOOLgjd">Liquid Button in JS</a>
+  Hi, introducing Liquid Button for Flutter. It supports Web and Mobile, not tested on Ios. Inspired by <a href="https://codepen.io/electerious/pen/gOOLgjd">Liquid Button in JS</a>.
 </p>
 
 ## Preview
@@ -27,7 +27,7 @@ Download sample apk as shown in example from releases.
 <a href='https://github.com/iamSahdeep/liquid_button/releases'><img alt='Get it from Github Releases' src='https://i0.wp.com/dimitrology.com/wp-content/uploads/2017/02/download-apk.png?resize=172%2C100&ssl=1' width="200" height="100"/></a>
 
 
-Experience Live Demo on :
+Experience Live Demo on (not on mobile) : https://iamsahdeep.github.io/liquid_button/#/
 
 
 ## Getting Started
@@ -48,6 +48,43 @@ Experience Live Demo on :
   import 'package:liquid_button/liquid_button.dart';
   ```
 
+# Example
+
+    - Look for complete example in [example](https://github.com/iamSahdeep/liquid_button/blob/master/example) folder.
+    - Remember to wrap it with GestureDetector or InkWell, might include in next version.
+
+```
+                LiquidButton(
+                  expandFactor: 20,
+                  backgroundColor: Colors.black87,
+                  height: 100,
+                  child: Text(
+                    "Liquid Button",
+                    style: TextStyle(
+                        fontSize: 30,
+                        color: Colors.white,
+                        fontWeight: FontWeight.bold),
+                  ),
+                  gradientColor: Colors.black54,
+                  width: 400,
+                ),
+```
+
+## Attributes
+Here are some of the attributes in which height,width and background color is the required. Rest can be left to have default values.
+    - **expandFactor** : (double) Allows you to decide Expansion of the button while animating. Should be less than 50.
+    - **backgroundColor** : (Color) Color of the button.
+    - **gradientColor** : (Color) If you want gradient effect onHover, if not given no color effect will be there.
+    - **retainGradient** : (bool) If you want to retain the gradient effect when mouse leaves the button area. Default is false.
+    - **gap** : (int) Integer to provide gap between subsequent point while painting the line. Do experiment with it, Should not be greater that height/2.
+
+# Known Issues
+
+    * **Lag on Web** - It generally happens when we are using multiple Liquid Buttons on same screen due to usage of `MouseRegion`.You might experience the same on the live demo also. Check this issue https://github.com/flutter/flutter/issues/41194
+    * **Gesture not working on Web on Mobile** - Need to work on it..
+    * **Note** : Please report any kind of bugs you are experiencing.
+
+
 ## Author & support
 This project is created by [Sahdeep Singh](https://github.com/iamSahdeep) but with lots of support and help.
 

diff --git a/docs/flutter_service_worker.js b/docs/flutter_service_worker.js
@@ -10,7 +10,7 @@ const RESOURCES = {
 "/icons/Icon-192.png": "ac9a721a12bbc803b44f645561ecb1e1",
 "/icons/Icon-512.png": "96e752610906ba2a93c65f8abe1645f1",
 "/index.html": "78d31418eaed5d57fca7c2fdf97bcf8e",
-"/main.dart.js": "317f55c734ace9f61de321d6017a2829",
+"/main.dart.js": "bacba4c70baa73b6ba82a5a7a4cdc93c",
 "/manifest.json": "8a94171cfcf7294d671115b50e5b70b5"
 };