prepared for release 1.0.0

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0
+
+* Added invalid line colors
+* Added reveal letter animation with decoration options
+* Added onUpdate line to show the construction of the word real time
+* Some bug fixes and improvements
+
 ## 0.0.8
 
 * Gradient Colors, TextStyles and Line Decoration updated to the Crossword Widget

README.md

@@ -47,7 +47,7 @@ a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
 
 ```yaml
 dependencies:
-  crossword: ^0.0.8
+  crossword: ^1.0.0
 ```
 
 Import the package in your Dart code and instantiate the `Crossword` widget.
@@ -126,6 +126,30 @@ Crossword(
 - `strokeCap`: Accepts a `StrokeCap` to update the stroke cap of the lines.
 - `lineTextStyle`: Accepts a `TextStyle` to update the style of the words which are drawn by the user.
 
+## Reveal Letter Animation
+
+- Use a Global Key to access the `Crossword` widget and call the `animate` method to animate the letter
+decoration.
+
+```dart
+final GlobalKey<CrosswordState> _crosswordState = GlobalKey();
+```
+- Pass the `GlobalKey` to the `Crossword` widget
+
+```dart
+ Crossword(key: _crosswordState);
+```
+- Access the `Crossword` widget using the global key  and call the `animate` method to animate the letter
+
+```dart
+//offset is the position of the letter in the crossword
+ crosswordState.currentState!.animate(offset: const Offset(7, 3));
+```
+
+- `revealLetterDecoration`: Accepts a `RevealLetterDecoration` to animate the decoration of the
+  letters 
+
+
 ## Contributions
 
 Contributions are welcome! If you find a bug or want to add a feature, please file an issue 

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.8"
+    version: "1.0.0"
   cupertino_icons:
     dependency: "direct main"
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: crossword
 description: A Flutter package providing a user interface for solving crossword puzzles in your app.
-version: 0.0.8
+version: 1.0.0
 homepage: https://github.com/Amonc/crossword
 
 environment: