summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDonald Stufft <donald@stufft.io>2015-06-12 17:04:32 -0400
committerDonald Stufft <donald@stufft.io>2015-06-12 17:04:32 -0400
commit960645a2dc811cc5715dd44c3baadaab80921034 (patch)
tree1701096fff3ddf4dcca4f6e45783da36b63670ac /README.rst
parent1787cafb83a02e1e2e740fbdd5b30c32dfc62cf2 (diff)
downloadpy-bcrypt-git-960645a2dc811cc5715dd44c3baadaab80921034.tar.gz
Document the adjustable prefix
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 1377646..1fa3bbd 100644
--- a/README.rst
+++ b/README.rst
@@ -64,6 +64,14 @@ the work factor merely pass the desired number of rounds to
... print("It Does not Match :(")
+Adjustable Prefix
+~~~~~~~~~~~~~~~~~
+
+Another one of bcrypt's features is an adjustable prefix to let you define what
+libraries you'll remain compatible with. To adjust this, pass either ``2a`` or
+``2b`` (the default) to ``bcrypt.gensalt(prefix=b"2b")`` as a bytes object.
+
+
Compatibility
-------------