Skip to content

Commit

Permalink
Add package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
petarov committed Apr 23, 2024
1 parent 8761076 commit f6da988
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Package translitbg is a Bulgarian-language transliteration package. The API
// can be used in a very simple way to encode cyrillic-characters text to its
// corresponding latin-characters version.
//
// Example:
//
// tr := translitbg.New()
// tr.Encode("абвгдежзийклмнопрстуфхцчшщъьюя")
// // Output: abvgdezhziyklmnoprstufhtschshshtayyuya
//
// There are no state-related parameters stored in the translitbg object, so
// the same instance can be used to encode more text without the need to create
// new objects every time.
package translitbg

0 comments on commit f6da988

Please sign in to comment.