Chore: release version 1.2.3

CatHood0 · Aug 27, 2024 · 6feb9f7 · 6feb9f7
1 parent f9130ba
commit 6feb9f7
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## 1.2.3
+
+* Chore: removed deprecated member from Tokenizer.
+* Feat: support for generic return in Tokenizer class by @CatHood0 in https://github.com/CatHood0/simple_spell_checker/pull/7
+* Feat: make public Checker API by @CatHood0 in https://github.com/CatHood0/simple_spell_checker/pull/8
+
+**Full Changelog**: https://github.com/CatHood0/simple_spell_checker/compare/V1.2.2...V1.2.3
+
 ## 1.2.2
 
 * Fix: some parameters in `MultiSpellChecker` are not used by @CatHood0 in https://github.com/CatHood0/simple_spell_checker/pull/4

diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
-# Simple Spell Checker
+<h1 align="center">Simple Spell Checker</h1>
 
-![simple spell checker example preview](https://github.com/CatHood0/resources/blob/Main/simple_spell_checker/clideo_editor_49b21800e993489fa4cdbbd160ffd60c%20(online-video-cutter.com).gif)
+<p align="center">
+<img src=https://github.com/CatHood0/resources/blob/Main/simple_spell_checker/clideo_editor_49b21800e993489fa4cdbbd160ffd60c%20(online-video-cutter.com).gif />
+</p>
 
 **Simple Spell Checker** is a simple but powerful spell checker, that allows to all developers detect and highlight spelling errors in text. The package also allows customization of languages, providing efficient and adaptable spell-checking for various applications.
 
@@ -134,13 +136,13 @@ List<Widget>? result = spellChecker.checkBuilder<Widget>(
 
 ### Creating your custom `Tokenizer`
 
-Use the `wordTokenizer` param from constructor to set a custom instance of your `Tokenizer` or use `setNewTokenizer()` or `setWordTokenizerToDefault()`.
+Use the `wordTokenizer` param from constructor to set a custom instance of your `Tokenizer` or use `setNewTokenizer()` or `setWordTokenizerToDefault()`. _By default on `MultiSpellChecker` and `SimpleSpellChecker` only accept `Tokenizer` implementations with `List<String>` types only_.
 
 #### Example of a custom `Tokenizer`:
 
 ```dart
 /// custom tokenizer implemented by the package
-class CustomWordTokenizer extends Tokenizer {
+class CustomWordTokenizer extends Tokenizer<List<String>> {
   CustomWordTokenizer() : super(separatorRegExp: RegExp(r'\S+|\s+'));
 
   @override

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -145,7 +145,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.2.2"
+    version: "1.2.3"
   sky_engine:
     dependency: transitive
     description: flutter

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: simple_spell_checker
 description: "A simple and powerful spell checker, allowing developers to detect and highlight spelling errors in text"
-version: 1.2.2
+version: 1.2.3
 homepage: https://github.com/CatHood0/simple_spell_checker
 issue_tracker: https://github.com/CatHood0/simple_spell_checker/issues/
 documentation: https://github.com/CatHood0/simple_spell_checker/