Update didStateChange method section in readme file

Author: gonuit

CHANGELOG.md

@@ -1,16 +1,13 @@
-
-## 1.0.0-nullsafety.1
+## 1.0.0
 - Stable nullsafety release.
+- **BREAKING**: opt into null safety
+  - Dart SDK constraints: >=2.12.0-0 <3.0.0
 - **BREAKING**: Removed `prevState` from `IndicatorController` class.
   Because flutter only marks the widget that it is ready for rebuild, it is possible that the controller state will change more than once during a single frame what causes one or more steps to be skipped. To still use `prevState` and `didChangeState` method, you can use `IndicatorStateHelper`. Take a look at `check_mark_indicator.dart` or `warp_indicator.dart` for example usage.
 - Added `IndicatorStateHelper` class.
 - Added `IndicatorController` unit tests.
 - Added warp indicator example.
-
-## 1.0.0-nullsafety.0
-
-- **BREAKING**: opt into null safety
-  - Dart SDK constraints: >=2.12.0-0 <3.0.0
+- Added `stopDrag` method to the `IndicatorController` class. It allows you to stop current user drag.
 
 ## 0.9.0
 

README.md

@@ -9,8 +9,9 @@ If there is something that can be improved, fixed or you just have some great id
 If you implemented your own custom refresh indicator with this library and you want it to be mentioned here or provided as an example to the eample app, just open a pull request [HERE](https://github.com/gonuit/flutter-custom-refresh-indicator/pulls).
 
 ### Table of Contents
+
 - [Flutter Custom Refresh Indicator](#flutter-custom-refresh-indicator)
-    - [Table of Contents](#table-of-contents)
+  - [Table of Contents](#table-of-contents)
 - [QUICK START](#quick-start)
 - [Examples](#examples)
 - [Documentation](#documentation)
@@ -72,15 +73,12 @@ Almost all of these examples are available in the example application.
 
 | Warp indicator [[SOURCE CODE](example/lib/indicators/warp_indicator.dart)] |                Envelope indicator                |
 | :------------------------------------------------------------------------: | :----------------------------------------------: |
-|               ![warp_indicator](readme/warp_indicator.gif)               | ![letter_indicator](readme/letter_indicator.gif) |
+|                ![warp_indicator](readme/warp_indicator.gif)                | ![letter_indicator](readme/letter_indicator.gif) |
 
 | Indicator with complete state [[SOURCE CODE](example/lib/indicators/check_mark_indicator.dart)] |                               Your indicator                                |
 | :---------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------: |
 |           ![indicator_with_complete_state](readme/indicator_with_complete_state.gif)            | Have you created a fancy refresh indicator? This place is for you. Open PR. |
 
-
-
-
 # Documentation
 
 ## CustomRefreshIndicator widget
@@ -92,7 +90,7 @@ Almost all of these examples are available in the example application.
 ### Controller state and value changes.
 
 The best way to understand how the "CustomRefreshIndicator" widget changes its controller data is to see the example 😉. An example is available in the example application.
-    
+
 ![Controller_Data](readme/controller_data.gif)
 
 | state        | value   | value description                                                                                       | Description                                                                                                                                                                                                                              |
@@ -104,34 +102,52 @@ The best way to understand how the "CustomRefreshIndicator" widget changes its c
 | **hiding**   | `<=1.0` | Value decreses in duration of `draggingToIdleDuration` or `loadingToIdleDuration` arguments to `0.0`.   | Indicator is hiding after:<br />- User ended dragging when indicator was in `dragging` state.<br />- Future returned from `onRefresh` function is resolved.<br />- Complete state ended.<br />- User started scrolling through the list. |
 | **complete** | `==1.0` | Value equals `1.0` for duration of `completeStateDuration` argument.                                    | **This state is OPTIONAL, provide `completeStateDuration` argument with non null value to enable it.**<br /> Loading is completed.                                                                                                       |
 
-___
+---
 
-### `didStateChange`
-With this method, you can easily check if the indicator's state has changed.
+### IndicatorStateHelper
 
+With the IndicatorStateHelper class, you can easily track indicator's state changes. Example usage can be found [HERE](example/lib/indicators/check_mark_indicator.dart).
+  
+All you need to do is to update it's value on every controller update.
+```dart
+CustomRefreshIndicator(
+  onRefresh: onRefresh,
+  child: widget.child,
+  builder: (
+    BuildContext context,
+    Widget child,
+    IndicatorController controller,
+  ) => AnimatedBuilder(
+    animation: controller,
+    builder: (BuildContext context, Widget? _) {
+      /// Now every state change will be tracked by the helper class.
+      _helper.update(controller.state);
+    // ...
+```
+Then you can simply track state changes:
 ```dart
 /// When the state changes to [idle]
-if(controller.didStateChange(to: IndicatorState.idle)) {
+if(_helper.didStateChange(to: IndicatorState.idle)) {
   // Code...
 }
 
 /// When the state changes from [idle] to [dragging]
-if (controller.didStateChange(
+if (_helper.didStateChange(
   from: IndicatorState.idle,
   to: IndicatorState.dragging,
 )) {
   // Code...
 }
 
 /// When the state changes from [idle] to another.
-if (controller.didStateChange(
+if (_helper.didStateChange(
   from: IndicatorState.idle,
 )) {
   // Code...
 }
 
 /// When the state changes.
-if (controller.didStateChange()) {
+if (_helper.didStateChange()) {
   // Code...
 }
-```
+```