Small updates to the README

riverrun · Jun 16, 2019 · c0ff998 · c0ff998
1 parent 1f1146a
commit c0ff998
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/lib/bcrypt.ex b/lib/bcrypt.ex
@@ -1,6 +1,6 @@
 defmodule Bcrypt do
   @moduledoc """
-  Bcrypt password hashing library main module.
+  Elixir wrapper for the Bcrypt password hashing function.
 
   This module implements the Comeonin and Comeonin.PasswordHash behaviours,
   providing the following functions:
@@ -35,14 +35,14 @@ defmodule Bcrypt do
 
   ### add_hash
 
-    * `hash_key` - the key used in the map for the password hash
+    * `:hash_key` - the key used in the map for the password hash
       * the default is `password_hash`
 
   ### check_pass
 
-    * `hash_key` - the key used in the user struct for the password hash
+    * `:hash_key` - the key used in the user struct for the password hash
       * if this is not set, `check_pass` will look for `password_hash`, and then `encrypted_password`
-    * `hide_user` - run `no_user_verify` to prevent user enumeration
+    * `:hide_user` - run `no_user_verify` to prevent user enumeration
       * the default is true
       * set this to false if you do not want to hide usernames