From df6d5de5feb8977c066183ddaf4f30136eb38000 Mon Sep 17 00:00:00 2001 From: Jacob Moura Date: Sat, 14 Dec 2024 20:55:31 -0300 Subject: [PATCH] fix documentation --- CHANGELOG.md | 3 +++ README.md | 31 +++++++++++++++++-------------- example/lib/main.dart | 2 +- pubspec.yaml | 2 +- 4 files changed, 22 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5be9380..b352a0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 1.1.1 +* FIX: documentation + ## 1.1.0 * NEW: State History. diff --git a/README.md b/README.md index ff51030..1b625a4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ --- +## Getting Started + +1. Add the package to your `pubspec.yaml`: + ```yaml + dependencies: + result_command: x.x.x + result_dart: 2.x.x + ``` + +2. Wrap your actions in commands: + - Use pre-defined `Command` types to encapsulate your logic. + - Attach listeners to update your UI dynamically. + +3. Execute commands from your UI and enjoy the benefits of encapsulated logic and state tracking. + +--- + ## Why Use Result Command? 1. **Encapsulation**: Wrap your business logic into reusable commands. @@ -273,21 +290,7 @@ Future.delayed(Duration(seconds: 3), () { --- -## Getting Started - -1. Add the package to your `pubspec.yaml`: - ```yaml - dependencies: - result_command: ^1.0.0 - ``` - -2. Wrap your actions in commands: - - Use pre-defined `Command` types to encapsulate your logic. - - Attach listeners to update your UI dynamically. -3. Execute commands from your UI and enjoy the benefits of encapsulated logic and state tracking. - ---- ## Contribute diff --git a/example/lib/main.dart b/example/lib/main.dart index 415f2ef..1389f0c 100644 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -68,7 +68,7 @@ class MyHomePage extends StatelessWidget { child: const Icon(Icons.add), ); }, - ), // This trailing comma makes auto-formatting nicer for build methods. + ), ); } } diff --git a/pubspec.yaml b/pubspec.yaml index 8e698cd..2ffd379 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: result_command description: "A command pattern implementation for Dart and Flutter using result_dart package." -version: 1.1.0 +version: 1.1.1 repository: https://github.com/Flutterando/result_command environment: