Skip to content

Commit ed17841

Browse files
committed
Update README.md
1 parent 8361e84 commit ed17841

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
11
# sqlite3_arabic_tokenizer_flutter
22

3-
SQLite3 Arabic Tokenizer
3+
To use [sqlite3-arabic-tokenizer](https://github.com/GreentechApps/sqlite3-arabic-tokenizer) in Flutter.
4+
5+
# sqlite3-arabic-tokenizer
6+
7+
This is a custom [FTS5](https://www.sqlite.org/fts5.html) tokenizer for SQLite. If you don't know what is a custom
8+
tokenizer, you can check [this](https://www.sqlite.org/fts5.html#custom_tokenizers).
9+
10+
This tokenizer will remove diacritics from Arabic text. Suppose, you have a Quran app where you want to search without
11+
Arabic diacritics. Like you want to match 'الحمد' with 'ٱلْحَمْدُ'. You can use this tokenizer to create a virtual fts5
12+
table that will do this.
13+
14+
# Getting Started
15+
16+
First, add `sqlite3_arabic_tokenizer_flutter` as a dependency in your pubspec.yaml file.
17+
18+
```yaml
19+
dependencies:
20+
sqlite3_arabic_tokenizer_flutter: ^0.0.1
21+
```
22+
23+
Don't forget to `flutter pub get`.
24+
25+
Please check the __example app__ for detailed implementation.
26+
For more info, read this [article](https://snnafi.medium.com/search-arabic-text-with-diacritics-using-sqlite-tokenizer-97326b938b4c)
27+
28+
429

5-
## Getting Started
630

731

pubspec.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ flutter:
3939
pluginClass: Sqlite3ArabicTokenizerFlutterPlugin
4040
ios:
4141
pluginClass: Sqlite3ArabicTokenizerFlutterPlugin
42-
linux:
43-
pluginClass: Sqlite3ArabicTokenizerFlutterPlugin
42+
# linux:
43+
# pluginClass: Sqlite3ArabicTokenizerFlutterPlugin
4444
macos:
4545
pluginClass: Sqlite3ArabicTokenizerFlutterPlugin
4646
windows:

0 commit comments

Comments
 (0)