Merge branch 'master' of https://github.com/alexsergivan/transliterator

README.md

@@ -1,11 +1,14 @@
-GO Transliterator
+Golang text Transliterator
 ==============
 
 [![Build Status](https://travis-ci.com/alexsergivan/transliterator.svg?branch=master)](https://travis-ci.com/github/alexsergivan/transliterator)
 [![Coverage Status](https://coveralls.io/repos/github/alexsergivan/transliterator/badge.svg)](https://coveralls.io/github/alexsergivan/transliterator)
+[![Go Report Card](https://goreportcard.com/badge/github.com/alexsergivan/transliterator)](https://goreportcard.com/report/github.com/alexsergivan/transliterator)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9b062cd8ba9f4f7f850e167d6966b75b)](https://www.codacy.com/manual/alexsergivan/transliterator?utm_source=github.com&utm_medium=referral&utm_content=alexsergivan/transliterator&utm_campaign=Badge_Grade)
 
 
-GO Transliterator provides one-way string transliteration. It takes Unicode text and coverts to ASCII characters.
+Golang Transliterator provides one-way string transliteration. It takes Unicode text and converts to ASCII characters.
+Example use-case: transliterate cyrilic city name to be able to use it in the url ("Київ" ==> "Куiv").
 
 For now, only these languages have specific transliteration rules: DE, DA, EO, RU, BG, SV, HU, HR, SL, SR, NB, UK, MK, CA, BS. For other languages, general ASCII transliteration rules will be applied. Also, this package supports adding custom transliteration rules for your specific use-case. Please check the examples section below.
 
@@ -18,7 +21,7 @@ go get -u github.com/alexsergivan/transliterator
 ```
 
 
-Language specific transliteration example:
+Language specific transliteration example
 ------
 
 ```go
@@ -39,14 +42,14 @@ func main() {
 	anotherText := "你好"
 	fmt.Println(trans.Transliterate(anotherText, "")) // Result: Ni Hao
 
-	text := "Київ"
-	fmt.Println(trans.Transliterate(text, "uk")) // Result: Kyiv
-	fmt.Println(trans.Transliterate(text, "en")) // Result: Kiyiv
-	fmt.Println(trans.Transliterate(text, "")) // Result: Kiyiv
+	oneMoreText := "Київ"
+	fmt.Println(trans.Transliterate(oneMoreText, "uk")) // Result: Kyiv
+	fmt.Println(trans.Transliterate(oneMoreText, "en")) // Result: Kiyiv
+	fmt.Println(trans.Transliterate(oneMoreText, "")) // Result: Kiyiv
 }
 ```
 
-Adding of custom Language translitartion rules:
+Adding of custom Language translitartion rules
 ------
 
 ```go

languages/de.go

@@ -5,7 +5,9 @@ var DE = map[rune]string{
 	0xC4: "Ae",
 	0xD6: "Oe",
 	0xDC: "Ue",
+	0xDF: "ss",
 	0xE4: "ae",
 	0xF6: "oe",
 	0xFC: "ue",
+	0x1E9E: "SS",
 }