Document the new errors argument.

1 files changed, 11 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 220a0bf..f3e35e5 100644
--- a/README.rst
+++ b/README.rst
@@ -64,6 +64,17 @@ Python 3.x)::
     >>> unidecode(u"\u5317\u4EB0")
     'Bei Jing '
 
+You can also specify an *errors* argument to ``unidecode()`` that determines
+what Unidecode does with characters that are not present in its transliteration
+tables. The default is ``'ignore'`` meaning that Unidecode will ignore those
+characters (replace them with an empty string). ``'strict'`` will raise a
+`UnidecodeError`. The exception object will contain an *index* attribute that
+can be used to find the offending character. ``'replace'`` will replace them
+with ``'?'`` (or another string, specified in the *replacement_char* argument).
+``'preserve'`` will keep the original, non-ASCII character in the string. Note
+that if ``'preserve'`` is used the string returned by ``unidecode()`` will not
+be ASCII-encodable!
+
 A utility is also included that allows you to transliterate text from the
 command line in several ways. Reading from standard input::