Merge pull request #8 from bfirsh/crockford-base32

Add Crockford's base32 and performance improvements

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
index 797bd78..f933880 100644
--- a/README.md
+++ b/README.md
@@ -87,3 +87,16 @@ differ.
 If not defined, the redirect view will try to guess the proper domain by
 consulting the ``django.contrib.sites`` framework, if installed, or the
 requested domain, if not.
+
+#### ``SHORTURLS_DEFAULT_CONVERTER``
+
+The converter that is used to translate between short URLs and model IDs.
+Defaults to the built in base 62 conversion.
+
+Available converters:
+
+ - `shorturls.baseconv.base62` Base 62 encoding.
+ - `shorturls.baseconv.base32` [Douglas Crockford's base 32.](http://www.crockford.com/wrmg/base32.html)
+ - `shorturls.baseconv.hexconv` Hex encoding.
+ - `shorturls.baseconv.bin` Binary encoding, because why not.
+