Updated readme, license and changelog

Author: ufrshubham

CHANGELOG.md

@@ -1,3 +1,3 @@
 ## 0.0.1
 
-* TODO: Describe initial release.
+* Added MultiValueListenableBuilder widget.

LICENSE

@@ -1 +1,21 @@
-TODO: Add your license here.
+MIT License
+
+Copyright (c) 2021 [DevKage]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,14 +1,53 @@
-# multi_value_listenable_builder
+# MultiValueListenableBuilder
 
-A new Flutter package project.
+A widget to listen to multiple [ValueListenable](https://api.flutter.dev/flutter/widgets/ValueListenableBuilder-class.html)s in Flutter.
+
+## Usage
+
+- Add the multi_value_listenable_builder as a dependency in your project.
+
+- Import `package:multi_value_listenable_builder/multi_value_listenable_builder.dart` in required files.
+
+- Use `MultiValueListenableBuilder` just like any other widget.
+
+```dart
+import 'package:multi_value_listenable_builder/multi_value_listenable_builder.dart';
+
+MultiValueListenableBuider(
+    // Add all ValueListenables here.
+    valueListenables: [
+        listenable0,
+        listenable1,
+        listenable2,
+        .
+        .
+        listenableN
+    ],
+    builder: (context, values, child) {
+        // Get the updated value of each listenable
+        // in values list.
+        return YourWidget(
+            values.elementAt(0),
+            values.elementAt(1),
+            values.elementAt(2),
+            .
+            .
+            values.elementAt(N),
+            child: child // Optional child.
+        );
+    },
+    child: YourOptionalChildWidget(),
+)
+```
+
+A detailed and working example can be found [here](https://github.com/ufrshubham/multi-value-listenable-builder/example/).
 
 ## Getting Started
 
-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.
+Learn more about Dart, Flutter and working with packages here.
+
+- [Dart](https://dart.dev/)
+
+- [Fluter](https://flutter.dev/)
 
-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.
+- [Developing packages & plugins](https://flutter.dev/docs/development/packages-and-plugins/developing-packages)

lib/src/multi_value_listenable_builder.dart

@@ -7,20 +7,21 @@ import 'package:flutter/material.dart'
         Container,
         ValueListenableBuilder;
 
-/// This widget can listen to multiple [ValueListenable]s and
-/// call given builder if any one of them changes.
+/// This widget listens to multiple [ValueListenable]s and
+/// calls given builder function if any one of them changes.
 class MultiValueListenableBuider extends StatelessWidget {
-  /// List of [ValueListenable]s.
+  /// List of [ValueListenable]s to listen to.
   final List<ValueListenable> valueListenables;
 
   /// The builder function to be called when value of any of the [ValueListenable] changes.
-  /// The order of values in [values] list will be same as [valueListenables].
+  /// The order of values list will be same as [valueListenables] list.
   final Widget Function(
       BuildContext context, List<dynamic> values, Widget? child) builder;
 
   /// An optional child widget which will be avaliable as child parameter in [builder].
   final Widget? child;
 
+  // The const constructor.
   const MultiValueListenableBuider({
     Key? key,
     required this.valueListenables,

pubspec.yaml

@@ -1,5 +1,5 @@
 name: multi_value_listenable_builder
-description: A Flutter package which allows to listening to multiple ValueListenables from a single widget.
+description: A Flutter package which allows to listening to multiple ValueListenables using a single widget.
 version: 0.0.1
 homepage: https://github.com/ufrshubham/multi-value-listenable-builder
 
@@ -15,37 +15,5 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
 
-# For information on the generic Dart part of this file, see the
-# following page: https://dart.dev/tools/pub/pubspec
-
-# The following section is specific to Flutter.
 flutter:
-  # To add assets to your package, add an assets section, like this:
-  # assets:
-  #   - images/a_dot_burr.jpeg
-  #   - images/a_dot_ham.jpeg
-  #
-  # For details regarding assets in packages, see
-  # https://flutter.dev/assets-and-images/#from-packages
-  #
-  # An image asset can refer to one or more resolution-specific "variants", see
-  # https://flutter.dev/assets-and-images/#resolution-aware.
-  # To add custom fonts to your package, add a fonts section here,
-  # in this "flutter" section. Each entry in this list should have a
-  # "family" key with the font family name, and a "fonts" key with a
-  # list giving the asset and other descriptors for the font. For
-  # example:
-  # fonts:
-  #   - family: Schyler
-  #     fonts:
-  #       - asset: fonts/Schyler-Regular.ttf
-  #       - asset: fonts/Schyler-Italic.ttf
-  #         style: italic
-  #   - family: Trajan Pro
-  #     fonts:
-  #       - asset: fonts/TrajanPro.ttf
-  #       - asset: fonts/TrajanPro_Bold.ttf
-  #         weight: 700
-  #
-  # For details regarding fonts in packages, see
-  # https://flutter.dev/custom-fonts/#from-packages
+  uses-material-design: false