fix documentation

Flutterando · Dec 14, 2024 · df6d5de · df6d5de
1 parent 6ed2fbc
commit df6d5de
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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:
-Original file line number
+Diff line change
@@ Expand Up / @@ -68,7 +68,7 @@ class MyHomePage extends StatelessWidget { @@
                 child: const Icon(Icons.add),
               );
             },
-          ), // This trailing comma makes auto-formatting nicer for build methods.
+          ),
         );
       }
     }