Skip to content
This repository has been archived by the owner on Aug 19, 2020. It is now read-only.

Commit

Permalink
Adds more warnings to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
norman committed Jun 24, 2010
1 parent acd3bf3 commit 12b458b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Expand Up @@ -29,3 +29,23 @@ If you also install either the [Unicode](http://github.com/blackwinter/unicode)
**or** [Active Support](http://github.com/rails/rails) gems, Unidecoder will
also perform Unicode normalization before attempting to transliterate strings
to ASCII.

## Warnings

While this is a neat trick, in practice many transliterations end up being
fairly useless. For example, all Chinese characters are transliterated to
Mandarin Chinese. Since Japanese uses Chinese characters writing, but
pronounces them differently from Mandarin, this makes the transliteration of
Japanese with this library useless.

Some languages, like Russian, would most correctly transliterate some letters
based on context, rather than a 1-1 mapping with ASCII. This library does not
do that.

Other languages, like Hebrew and Arabic, don't write vowels, but assume them
from context, so the ASCII representation of these langages given by this
library will look fairly ugly to native speakers.

Basically, your milage may vary. I don't speak every language used by this
library, so there are certain to be limitations and errors. Your feedback is
most appreciated!

0 comments on commit 12b458b

Please sign in to comment.