README.md fixes (#8)

Author: JPM84

CHANGELOG.md

@@ -1,16 +1,15 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
-
-## [Unreleased]
+## [0.1.1](https://github.com/coodoo-io/coo_extensions/releases/tag/0.1.1)
+### Added
+- Dokumentation of methods
+- Improved README.md file
 
-## [0.1.0] - 2024-04-23
+## [0.1.0](https://github.com/coodoo-io/coo_extensions/releases/tag/0.1.0)
 ### Added
 - String extensions: `isNullOrEmpty`, `obscureText`, `obscureTextSegment`
 - DateTime extensions: `isToday`, `isYesterday`, `isSameYear`, `isAfterOrEqual`, `isBeforeOrEqual`, `isBetween`
 - BuildContext extensions: `isLightMode`, `isDarkMode`, `deviceWidth`, `deviceHeight`
 - Number extensions: `isBetween`
 - Form extensions: `isValid`
 
-[Unreleased]: https://github.com/coodoo-io/coo_extensions/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/coodoo-io/coo_extensions/releases/tag/v0.1.0

README.md

@@ -9,7 +9,7 @@ To use this package, add `coo_extensions` as a dependency in your `pubspec.yaml`
 
 ```yaml
 dependencies:
-  coo_extensions: ^0.1.0
+  coo_extensions: ^0.1.1
 ```
 
 Then, run `flutter pub get` to install the package.

lib/coo_extensions.dart

@@ -1,3 +1,4 @@
+/// The coo(l) extensions
 library coo_extensions;
 
 export 'extensions/build_context.extension.dart';

lib/extensions/date_time.extension.dart

@@ -19,16 +19,27 @@ extension DateTimeExtension on DateTime {
     return DateTime.now().year == year;
   }
 
+  /// Checks if the current DateTime instance is after or equal to the given [dateTime].
+  /// Returns `true` if it is, `false` otherwise.
   bool isAfterOrEqual(DateTime dateTime) {
     final isAtSameMomentAs = dateTime.isAtSameMomentAs(this);
     return isAtSameMomentAs | isAfter(dateTime);
   }
 
+  /// Checks if the current DateTime instance is before or equal to the given [dateTime].
+  /// Returns `true` if it is, `false` otherwise.
   bool isBeforeOrEqual(DateTime dateTime) {
     final isAtSameMomentAs = dateTime.isAtSameMomentAs(this);
     return isAtSameMomentAs | isBefore(dateTime);
   }
 
+  /// Checks if the current DateTime instance falls between the provided [fromDateTime] and [toDateTime].
+  ///
+  /// Returns `true` if the current DateTime instance is after or equal to [fromDateTime]
+  /// and before or equal to [toDateTime], otherwise returns `false`.
+  ///
+  /// This method internally uses [isAfterOrEqual] and [isBeforeOrEqual] methods to determine
+  /// if the current DateTime instance is within the specified range.
   bool isBetween(
     DateTime fromDateTime,
     DateTime toDateTime,

pubspec.yaml

@@ -1,6 +1,6 @@
 name: coo_extensions
 description: "coo(l) extensions! A set of commonly used Dart/Flutter extension to ease development."
-version: 0.1.0
+version: 0.1.1
 homepage: https://github.com/coodoo-io/coo_extensions
 
 environment: