add example image in README

CHANGELOG.md

@@ -18,4 +18,8 @@ pre-release version
 ## 0.1.0
 
 * Refactor main logic
-* Check overflow in all areas horizontally and vertically
+* Check overflow in all areas horizontally and vertically
+
+## 1.0.0
+
+* Update "How to Use" in README.md

README.md

@@ -11,20 +11,80 @@ Size the text to the size of the parent widget.
 It's similar to using a typical Text Widget.  
 Inputable arguments are left open the same as the arguments in Text Widget.
 ~~~
+
 final text = "Strings Strings...";
 final style = TextStyle(
     ...
     fontSize: 200,
     color: Colors.balck,
     ...
 );
-const SizeTailoredText(
-    text: text,
-    textStyle: style,
+SizeTailoredText(
+    ...
+    text,
+    width: 200,
+    height: 200,
+    style: style,
     maxLines: 5,
-);
+    minFontSize: 1,
+    textAlign: TextAlign.left,
+    ...
+),
+
 ~~~
 
+## Example
+
+<table style="border-collapse: collapse;border: 1px solid #dddddd;">
+    <tr>
+        <td>
+            <img alt="" src="https://aqoong.github.io/readme-assets/size-tailored-text/stt_no_sized.png" width="350"/>
+        </td>
+        <td>
+            <pre><code>
+SizeTailoredText(
+    text,
+    maxLines: 5,
+    minFontSize: 1,
+    textAlign: TextAlign.left,
+    style: style,
+);
+Text(
+    text,
+    maxLines: 5,
+    textAlign: TextAlign.left,
+style: style,
+);</code></pre>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <img alt="" src="https://aqoong.github.io/readme-assets/size-tailored-text/stt_sized.png" width="350"/>
+        </td>
+        <td>
+            <pre><code>
+SizeTailoredText(text,
+    width: 200,
+    height: 200,
+    maxLines: 5,
+    minFontSize: 1,
+    textAlign: TextAlign.left,
+    style: style,
+);
+SizedBox(
+    width: 200,
+    height: 200,
+    child: Text(
+        text,
+        maxLines: 5,
+        textAlign: TextAlign.left,
+        style: style,
+    ),
+);</code></pre>
+        </td>
+    </tr>
+</table>
+
 ## License
 
 MIT License

example/lib/main.dart

@@ -47,33 +47,20 @@ class _MyAppState extends State<MyApp> {
                 textAlign: TextAlign.left,
                 style: style,
               ),
-              Text(
-                text,
-                maxLines: 5,
-                style: style,
-
-              ),
-              // borderContainer(const Text(text, style: style)),
-              // SizeTailoredText(
-              //   text: text,
-              //   textStyle: style,
-              //   maxWidth: 100,
-              //   maxHeight: 100,
-              //   maxLines: 6,
-              //   textAlign: TextAlign.start,
-              // )
+              SizedBox(
+                width: 200,
+                height: 200,
+                child: Text(
+                  text,
+                  maxLines: 5,
+                  textAlign: TextAlign.left,
+                  style: style,
+                ),
+              )
             ],
           ),
         ),
       ),
     );
   }
-
-  Widget borderContainer(Widget child) => Container(
-        width: double.infinity,
-        height: 200,
-        decoration: const BoxDecoration(
-            border: Border.fromBorderSide(BorderSide(color: Colors.red))),
-        child: child,
-      );
 }

example/pubspec.lock

@@ -176,7 +176,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.1.0"
+    version: "1.0.0"
   sky_engine:
     dependency: transitive
     description: flutter

pubspec.yaml

@@ -1,6 +1,6 @@
 name: size_tailored_text
 description: "Size the text to the size of the parent widget."
-version: 0.1.0
+version: 1.0.0
 homepage: https://github.com/aqoong/size_tailored_text
 
 environment: