v1.1.1

Author: drxddy

CHANGELOG.md

@@ -37,4 +37,7 @@
 
 ## 1.1.0
   * added a `BlurhashTheImage` widget which takes an `ImageProvider` and gives out `ImageProvider` of the resulting blurry Image in one step.
-  * also made it clear that `BlurhashFFI.free()` should be only run when you are sure there are no more blurhashes to be decoded/encoded in your app.
+  * also made it clear that `BlurhashFFI.free()` should be only run when you are sure there are no more blurhashes to be decoded/encoded in your app.
+
+## 1.1.1
+  * modify readme.md to explain how to use `BlurhashTheImage` widget

README.md

@@ -11,6 +11,34 @@ Matches the official [Blurhash](https://github.com/woltapp/blurhash) implementat
 ## Usage
 To use this plugin, add `blurhash_ffi` as a dependency in your pubspec.yaml file
 
+**One Step (both Encoding & Decoding) Usage**
+```dart
+import 'package:blurhash_ffi/blurhash_ffi.dart';
+
+/// Encoding and Decoding all in One Step
+///
+/// `ImageProvider` in    -> Send your Image to be encoded.
+/// `ImageProvider` out   -> Get your blurry image version.
+
+class BlurhashMyImage extends StatelessWidget {
+  final String imageUrl;
+  const BlurhashMyImage({required this.imageUrl, super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Image(
+      image: BlurhashTheImage(
+        NetworkImage(imageUrl),  // you can use any image provider of your choice.
+          decodingHeight: 1920, decodingWidth: 1080),
+      alignment: Alignment.center,
+      fit: BoxFit.cover
+    );
+  }
+}
+
+
+```
+
 **Encoding**
 
 <?code-excerpt "readme_excerpts.dart (Example)"?>

example/lib/main.dart

@@ -1,4 +1,4 @@
-import 'package:blurhash_ffi/blurhash_the_image.dart';
+import 'package:blurhash_ffi/blurhash_ffi.dart';
 import 'package:flutter/material.dart';
 
 void main() {
@@ -57,26 +57,28 @@ class _MyAppState extends State<MyApp> {
                   Align(
                     alignment: Alignment.center,
                     child: SizedBox(
-                      height: 120,
-                      width: 120,
-                      child: Image(
-                        image: BlurhashTheImage(
-                          AssetImage(
-                              selectedImage == 2 ? 'assets/images/$selectedImage.png' :
-                              'assets/images/$selectedImage.jpg'),
-                          decodingWidth: 120,
-                          decodingHeight: 120,
-                        ),
-                        loadingBuilder: (context, child, loadingProgress) => loadingProgress == null
-                            ? child
-                            : const Center(
-                                child: CircularProgressIndicator(
-                                  color: Color(0xFFF1D4D4),
-                                ),
-                              ),
-                        frameBuilder: (context, child, frame, wasSynchronouslyLoaded) => child,
-                      ) 
-                    ),
+                        height: 120,
+                        width: 120,
+                        child: Image(
+                          image: BlurhashTheImage(
+                            AssetImage(selectedImage == 2
+                                ? 'assets/images/$selectedImage.png'
+                                : 'assets/images/$selectedImage.jpg'),
+                            decodingWidth: 120,
+                            decodingHeight: 120,
+                          ),
+                          loadingBuilder: (context, child, loadingProgress) =>
+                              loadingProgress == null
+                                  ? child
+                                  : const Center(
+                                      child: CircularProgressIndicator(
+                                        color: Color(0xFFF1D4D4),
+                                      ),
+                                    ),
+                          frameBuilder:
+                              (context, child, frame, wasSynchronouslyLoaded) =>
+                                  child,
+                        )),
                   )
               ],
             ),
@@ -110,3 +112,19 @@ class ImageSelect extends StatelessWidget {
     );
   }
 }
+
+class BlurhashMyImage extends StatelessWidget {
+  final String imageUrl;
+  const BlurhashMyImage({required this.imageUrl, super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return Image(
+      image: BlurhashTheImage(
+        NetworkImage(imageUrl), // you can use any image provider of your choice.
+          decodingHeight: 1920, decodingWidth: 1080),
+      alignment: Alignment.center,
+      fit: BoxFit.cover,
+    );
+  }
+}

example/pubspec.lock

@@ -23,7 +23,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.1.0"
+    version: "1.1.1"
   boolean_selector:
     dependency: transitive
     description:

lib/blurhash_ffi.dart

@@ -3,4 +3,5 @@ library blurhash_ffi;
 export './blurhash.dart';
 export './uiImage.dart';
 export 'blurhashffi_image.dart';
-export 'blurhashffi_widget.dart';
+export 'blurhashffi_widget.dart';
+export 'blurhash_the_image.dart';

pubspec.yaml

@@ -2,7 +2,7 @@ name: blurhash_ffi
 description: >-
   A compact, fast and easy to use blurry image placeholder generator for Flutter
   using native ffi bindings. 
-version: 1.1.0
+version: 1.1.1
 repository: https://github.com/folksable/blurhash_ffi
 
 environment: