updated readme

ali2236 · Mar 22, 2020 · c3012fb · c3012fb
1 parent 58aec2b
commit c3012fb
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,17 +2,40 @@
 
 A responsive grid view that changes it's cross axis child count based on the available horizontal size.
 
-![](pictures/1.jpg)
-![](pictures/2.jpg)
+This widget is great for creating responsive designs as the sized of tiles stays about the same across different screen sizes.
+
+### How does it work
+
+Using the width of tiles, `SmartGridview` will calculate the `crossAxisCount` for the underlying `GridView` with `maxWidth ~/ tileWidth`.
+
+The `tileHeight` is used with `tileWidth` to calculate `gridChildRatio`.  
+
+# Example
 
 ```dart
-SmartGridView(
+class MyApp extends StatelessWidget {
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: Scaffold(
+        appBar: AppBar(title: Text('Example')),
+        body: SmartGridView(
           tileWidth: 128,
           tileHeight: 168,
           children: List.generate(80, (index) => Card(
             child: GridTile(
               child: Text('tile #$index'),
             ),
           )),
-        )
-```
+        ),
+      ),
+    );
+  }
+}
+```
+
+##### Result
+
+![](pictures/1.jpg)
+![](pictures/2.jpg)
diff --git a/pictures/1.jpg b/pictures/1.jpg
diff --git a/pictures/2.jpg b/pictures/2.jpg
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,7 +1,7 @@
 name: smart_grid_view
 description: A responsive grid view that changes it's cross axis child count based on the available horizontal size.
 version: 0.1.0
-homepage:
+homepage: https://github.com/ali2236/smart_grid_view
 
 environment:
   sdk: ">=2.1.0 <3.0.0"