diff --git a/README.md b/README.md index 308dd08..794a3b7 100644 --- a/README.md +++ b/README.md @@ -12,28 +12,21 @@ Для транслитерации русских букв в ней уже предусмотрен встроенный словарь. Для других языков вы можете задать свой. Все достаточно просто: ```go -package translit_test +import "github.com/mdigger/translit" -import ( - "fmt" - "github.com/mdigger/translit" -) - -func ExampleRuTranslit() { - tests := []string{ - "Проверочная СТРОКА для транслитерации", - "ЧАЩА", - "ЧаЩа", - "Чаща", - "чаЩА", - } - for _, text := range tests { - fmt.Println(translit.RuTranslit(text)) - } - // Output: - // Proverochnaja STROKA dlja transliteracii - // CHASCHA - // ChaScha - // Chascha +tests := []string{ + "Проверочная СТРОКА для транслитерации", + "ЧАЩА", + "ЧаЩа", + "Чаща", + "чаЩА", } +for _, text := range tests { + fmt.Println(translit.Ru(text)) +} +// Output: +// Proverochnaja STROKA dlja transliteracii +// CHASCHA +// ChaScha +// Chascha ``` diff --git a/translit.go b/translit.go index 387668e..380c23a 100644 --- a/translit.go +++ b/translit.go @@ -52,7 +52,7 @@ var RuTransiltMap = map[rune]string{ 'я': "ja", } -// Translit выполняет транслитерацию в строке по указанной таблице и возвращает новую строку с +// Transliterate выполняет транслитерацию в строке по указанной таблице и возвращает новую строку с // результатом такого преобразования. Все символы, которые не указаны в таблице транслитерации, // останутся без изменения. // @@ -66,7 +66,7 @@ var RuTransiltMap = map[rune]string{ // // При желании, вы можете указать любую таблицу в качестве второго параметра при вызове функции, // по которой и будет выполнено данное преобразование. -func Translit(text string, translitMap map[rune]string) string { +func Transliterate(text string, translitMap map[rune]string) string { var result bytes.Buffer utf8text := utf8string.NewString(text) length := utf8text.RuneCount() @@ -94,7 +94,7 @@ func Translit(text string, translitMap map[rune]string) string { return result.String() } -// RuTranslit выполняет транслитерацию строки с учетом словаря для русской транслитерации. -func RuTranslit(text string) string { - return Translit(text, RuTransiltMap) +// Ru выполняет транслитерацию строки с учетом словаря для русской транслитерации. +func Ru(text string) string { + return Transliterate(text, RuTransiltMap) }