Initial

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..363c3a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Стеммер Портера для русского языка
+
+Стемминг - процесс получения основы слова из любой его формы. Иными словами, отсекает лишние суффиксы и окончания.
+
+Самое очевидное применение - в полнотекстовом поиске, где нужно, чтобы слово находилось, даже если у него другое окончание.
+
+Этот пакет - реализация [стеммера Портера](https://ru.wikipedia.org/wiki/Стемминг#Стеммер_Портера) для русского языка на Go.
+
+## Использование
+
+`основа := StemmerRu.StemWord("слово")`
+
+Преобразует слово на входе в его основу на выходе
+
+## Пример
+
+```
+package main
+
+import (
+	"fmt"
+	"github.com/neonxp/StemmerRu"
+)
+
+func main() {
+	fmt.Println(StemmerRu.StemWord("безмолвны") // выведет: безмолвн
+	fmt.Println(StemmerRu.StemWord("безмолвные") // выведет: безмолвн
+	fmt.Println(StemmerRu.StemWord("безмолвный") // выведет: безмолвн
+	fmt.Println(StemmerRu.StemWord("безмолвным") // выведет: безмолвн
+	fmt.Println(StemmerRu.StemWord("безмолвных") // выведет: безмолвн
+}
+```
\ No newline at end of file