Update docs

petarov · Apr 25, 2024 · 820357d · 820357d
1 parent a6bf4c2
commit 820357d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ tr.Encode("Стара планина")
 // Output: Stara planina
 tr.Encode("Горна Оряховица")
 // Output: Gorna Oryahovitsa
+tr.Encode("БЪЛГАРИЯ")
+// Output: BULGARIA
 ```
 
 # References

diff --git a/doc.go b/doc.go
@@ -16,10 +16,17 @@
 // the same instance can be used to encode more text without the need to create
 // new objects every time.
 //
-//	tr := translitbg.New()
-//	tr.Encode("Стара планина")
-//	// Output: Stara planina
+//		tr := translitbg.New()
+//		tr.Encode("Стара планина")
+//		// Output: Stara planina
+//
+//		tr.Encode("Горна Оряховица")
+//		// Output: Gorna Oryahovitsa
+//
+//	 There is an edge case where according to Bulgarian law the name "БЪЛГАРИЯ"
+//	 is an exception to the transliteration rule and must have its "Ъ"
+//	 transformed into a "U" instead of an "A". For example:
 //
-//	tr.Encode("Горна Оряховица")
-//	// Output: Gorna Oryahovitsa
+//		tr.Encode("БЪЛГАРИЯ")
+//		// Output: BULGARIA
 package translitbg