You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+21-3Lines changed: 21 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Textmogrify is a pre-alpha text manipulation library that hopefully works well w
4
4
5
5
## Usage
6
6
7
-
This library is currently available for Scala binary versions 2.13 and 3.1.
7
+
This library is currently available for Scala binary versions 2.13 and 3.2.
8
8
9
9
To use the latest version, include the following in your `build.sbt`:
10
10
@@ -26,9 +26,10 @@ libraryDependencies ++= Seq(
26
26
27
27
The Lucene module lets you use a Lucene [Analyzer][analyzer] to modify text, additionally it provides helpers to use `Analyzer`s with an fs2 [Stream][stream].
28
28
29
+
29
30
### Basics
30
31
31
-
Typical usage is to use the `AnalyzerBuilder` to configure an `Analyzer` and call `.tokenizer` to get a `Resource[F, String => F[Vector[String]]]`:
32
+
Typical usage is to use the `AnalyzerBuilder` to configure an `Analyzer` and call `.tokenizer[F]` to get a `Resource[F, String => F[Vector[String]]]`:
32
33
33
34
```scala mdoc:silent
34
35
importtextmogrify.lucene.AnalyzerBuilder
@@ -52,9 +53,26 @@ tokens.unsafeRunSync()
52
53
We can see that our text was lowercased and the unicode `ñ` replaced with an ASCII `n`.
53
54
54
55
56
+
### Languages
57
+
58
+
Textmogrify comes with support for multiple languages.
59
+
When setting up an `AnalyzerBuilder` you'll have access to language specific options once you call one of the helper language methods like `english` or `french`.
60
+
Specifying a language preserves the configuration set beforehand.
0 commit comments