diff --git a/README.md b/README.md index d46281e..2917b31 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Библиотека для транслитерации строк +Для использования библиотеки в Go выполните команду: + + $ go get -u github.com/mdigger/translit + +и пропишите ее в заголовке своего кода: + import "github.com/mdigger/translit" Данная библиотека обеспечивает простую транслитерацию. Для этого достаточно @@ -22,8 +28,8 @@ var RuTransiltMap = map[rune]string{ 'я': "ja", } ``` -RuTransiltMap описывает замены русских букв на английские при транслитерации. -Некоторые буквы заменяются ни на одну, а на две или три буквы латинского +`RuTransiltMap` описывает замены русских букв на английские при транслитерации. +Некоторые буквы заменяются не на одну, а на две или три буквы латинского алфавита. А мягкий знак вообще исчезает. Но такова обычная распространенная схема транслитерации. @@ -32,7 +38,7 @@ RuTransiltMap описывает замены русских букв на ан ```go func RuTranslit(text string) string ``` -RuTranslit выполняет транслитерацию строки с учетом словаря для русской +`RuTranslit` выполняет транслитерацию строки с учетом словаря для русской транслитерации. #### func Translit @@ -40,7 +46,7 @@ RuTranslit выполняет транслитерацию строки с уч ```go func Translit(text string, translitMap map[rune]string) string ``` -Translit выполняет транслитерацию в строке по указанной таблице и возвращает +`Translit` выполняет транслитерацию в строке по указанной таблице и возвращает новую строку с результатом такого преобразования. Все символы, которые не указаны в таблице транслитерации, останутся без изменения.