README

README.md

@@ -1,14 +1,112 @@
 # responsive_grid
 
-Responsive Grid Layout for Flutter
+Responsive Grid Layout and List for Flutter
 
-## Getting Started
+### Responsive Grid Layout
 
-This project is a starting point for a Dart
-[package](https://flutter.dev/developing-packages/),
-a library module containing code that can be shared easily across
-multiple Flutter or Dart projects.
+With `ResponsiveGridRow` and `ResponsiveGridCol` you can get the same behavior of [bootstrap](https://getbootstrap.com) Grid System
 
-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.
+Give every col the width it shall occupy at every size category assuming the total width is 12
+
+```dart
+        ResponsiveGridRow(
+          children: [
+            ResponsiveGridCol(
+              lg: 12,
+              child: Container(
+                height: 100,
+                alignment: Alignment(0, 0),
+                color: Colors.purple,
+                child: Text("lg : 12"),
+              ),
+            ),
+            ResponsiveGridCol(
+              xs: 6,
+              md: 3,
+              child: Container(
+                height: 100,
+                alignment: Alignment(0, 0),
+                color: Colors.green,
+                child: Text("xs : 6 \r\nmd : 3"),
+              ),
+            ),
+            ResponsiveGridCol(
+              xs: 6,
+              md: 3,
+              child: Container(
+                height: 100,
+                alignment: Alignment(0, 0),
+                color: Colors.orange,
+                child: Text("xs : 6 \r\nmd : 3"),
+              ),
+            ),
+            ResponsiveGridCol(
+              xs: 6,
+              md: 3,
+              child: Container(
+                height: 100,
+                alignment: Alignment(0, 0),
+                color: Colors.red,
+                child: Text("xs : 6 \r\nmd : 3"),
+              ),
+            ),
+            ResponsiveGridCol(
+              xs: 6,
+              md: 3,
+              child: Container(
+                height: 100,
+                alignment: Alignment(0, 0),
+                color: Colors.blue,
+                child: Text("xs : 6 \r\nmd : 3"),
+              ),
+            ),
+        )
+
+```
+
+<img src="images\1.jpg" width="300">   <img src="images\2.jpg" height="300">
+
+
+### Responsive Grid List
+
+`ResponsiveGridList` works differently in that you only specify a desired width for the items and spacing, and it will decide how many items shall fit in a line, and the width of the item and spacing will change (only small change) to fill the entire width
+
+```dart
+    ResponsiveGridList(
+        desiredItemWidth: 100,
+        minSpacing: 10,
+        children: [
+          1,
+          2,
+          3,
+          4,
+          5,
+          6,
+          7,
+          8,
+          9,
+          10,
+          11,
+          12,
+          13,
+          14,
+          15,
+          16,
+          17,
+          18,
+          19,
+          20
+        ].map((i) {
+          return Container(
+            height: 100,
+            alignment: Alignment(0, 0),
+            color: Colors.cyan,
+            child: Text(i.toString()),
+          );
+        }).toList()
+    )
+
+```
+
+
+<img src="images\3.jpg" width="300">   <img src="images\4.jpg" height="300">