aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Kiryukhin <a.kiryukhin@mail.ru>2019-05-28 13:24:40 +0300
committerAlexander Kiryukhin <a.kiryukhin@mail.ru>2019-05-28 13:24:40 +0300
commit5c7748b15e2fcc616c89492b85f367750e327d79 (patch)
treeec477f84fef127c42c3df0db55ab9792a74d4c99 /README.md
parent0911847693eac96cce52f18a6592a93e50464cf2 (diff)
Compatibility with https://github.com/caneroj1/stemmer libraryHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index edd8693..6ff53d4 100644
--- a/README.md
+++ b/README.md
@@ -9,12 +9,29 @@
Этот пакет - реализация [стеммера Портера](https://ru.wikipedia.org/wiki/Стемминг#Стеммер_Портера) для русского языка на Go.
+Интерфейс совместим со стеммером https://github.com/caneroj1/stemmer
+
## Использование
-`основа := StemmerRu.StemWord("слово")`
+`основа := StemmerRu.Stem("слово")`
Преобразует слово на входе в его основу на выходе
+Так же, из библиотеки https://github.com/caneroj1/stemmer взяты следющие методы:
+
+```
+ // stem a list of words
+ stems := StemmerRu.StemMultiple(strings)
+
+ // stem a list of words in place, modifying the original slice
+ StemmerRu.StemMultipleMutate(strings)
+
+ // stem a list of words concurrently. this also stems in place, modifying
+ // the original slice.
+ // NOTE: the order of the strings is not guaranteed to be the same.
+ StemmerRu.StemConcurrent(strings)
+```
+
## Пример
```