Updated README and added UPGRADE_v5 guide

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -1,7 +1,8 @@
-/_build
-/deps
-/doc
-/priv
-/.dialyzer
+/_build/
+/cover/
+/deps/
+/doc/
+/priv/
+/.fetch
 erl_crash.dump
 *.ez

.travis.yml

@@ -1,14 +1,5 @@
 language: elixir
-sudo: false
-
 elixir:
-  - 1.7.3
-
+  - 1.8.1
 otp_release:
   - 21.1
-
-script:
-  - mix test
-
-notifications:
-  email: false

README.md

@@ -1,40 +1,43 @@
 # Comeonin
 
-[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/alovedalongthe)
 [![Hex.pm Version](http://img.shields.io/hexpm/v/comeonin.svg)](https://hex.pm/packages/comeonin)
 [![Build Status](https://travis-ci.org/riverrun/comeonin.svg?branch=master)](https://travis-ci.org/riverrun/comeonin)
 [![Join the chat at https://gitter.im/comeonin/Lobby](https://badges.gitter.im/comeonin/Lobby.svg)](https://gitter.im/comeonin/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Comeonin is a specification for password hashing libraries in Elixir.
+Comeonin is a specification for password hashing libraries.
 
-## Version 5
+## News
 
-ADD LINK TO UPDATING TO V5 PAGE IN WIKI
+Comeonin has been updated to version 5.
 
-## Version 4
+In this version, Comeonin now provides two behaviours, Comeonin and
+Comeonin.PasswordHash, which password hash libraries then implement.
 
-ONLY NEED TO USE V4 IF USING BCRYPT 0.12 (if using old version of Erlang)
+See the UPGRADE_v5.md file for information about you can upgrade to
+version 5.
 
-ADD GENERAL INFO ABOUT THE WIKI
+## Password hashing algorithms
 
-## Use
-
-First, decide which algorithm to use (see
-[Choosing an algorithm](https://github.com/riverrun/comeonin/wiki/Choosing-the-password-hashing-algorithm)
-for more information).
+We recommend you use one of the following password hashing libraries.
 
 * Argon2 - [argon2_elixir](http://hexdocs.pm/argon2_elixir)
 * Bcrypt - [bcrypt_elixir](http://hexdocs.pm/bcrypt_elixir)
 * Pbkdf2 - [pbkdf2_elixir](http://hexdocs.pm/pbkdf2_elixir)
 
-### Problems / build errors
+Argon2 is considered to be the strongest password hashing algorithm,
+but Bcrypt and Pbkdf2 are viable alternatives. For more information, see
+[Choosing an algorithm](https://github.com/riverrun/comeonin/wiki/Choosing-the-password-hashing-algorithm).
 
-If you have any problems building argon2_elixir or bcrypt_elixir, see the
-[Comeonin wiki](https://github.com/riverrun/comeonin/wiki/Requirements).
+## Comeonin wiki
 
-### Deployment
+See the [Comeonin wiki](https://github.com/riverrun/comeonin/wiki) for more
+information on the following topics:
 
-See the [deployment guide](https://github.com/riverrun/comeonin/wiki/Deployment).
+* [algorithms](https://github.com/riverrun/comeonin/wiki/Choosing-the-password-hashing-algorithm)
+* [requirements](https://github.com/riverrun/comeonin/wiki/Requirements)
+* [deployment](https://github.com/riverrun/comeonin/wiki/Deployment)
+  * including information about using Docker
+* [references](https://github.com/riverrun/comeonin/wiki/References)
 
 ## Contributing
 
@@ -48,8 +51,8 @@ There are many ways you can contribute to the development of Comeonin, including
 ## Donations
 
 This software is offered free of charge, but if you find it useful
-and would like to make a donation, you can do so through
-[paypal](https://www.paypal.me/alovedalongthe)
+and you would like to buy me a cup of coffee, you can do so through
+[paypal](https://www.paypal.me/alovedalongthe).
 
 ### Documentation
 

UPGRADE_v5.md

@@ -0,0 +1,24 @@
+# Upgrading to version 5
+
+1. remove `:comeonin` from the `deps` function in your mix.exs file.
+2. update `:argon2_elixir` to version 2.0, `:bcrypt_elixir` to version 2.0,
+or `:pbkdf2_elixir` to version 1.0.
+3. using the conversion table below, edit the hashing functions.
+
+| Comeonin v4 | Comeonin v5 |
+| :---------- | :---------- |
+| Comeonin.Argon2.add_hash | Argon2.add_hash |
+| Comeonin.Argon2.check_pass | Argon2.check_pass |
+| Comeonin.Argon2.hashpwsalt | Argon2.hash_pwd_salt |
+| Comeonin.Argon2.checkpw | Argon2.verify_pass |
+| Comeonin.Argon2.dummy_checkpw | Argon2.no_user_verify |
+| Comeonin.Bcrypt.add_hash | Bcrypt.add_hash |
+| Comeonin.Bcrypt.check_pass | Bcrypt.check_pass |
+| Comeonin.Bcrypt.hashpwsalt | Bcrypt.hash_pwd_salt |
+| Comeonin.Bcrypt.checkpw | Bcrypt.verify_pass |
+| Comeonin.Bcrypt.dummy_checkpw | Bcrypt.no_user_verify |
+| Comeonin.Pbkdf2.add_hash | Pbkdf2.add_hash |
+| Comeonin.Pbkdf2.check_pass | Pbkdf2.check_pass |
+| Comeonin.Pbkdf2.hashpwsalt | Pbkdf2.hash_pwd_salt |
+| Comeonin.Pbkdf2.checkpw | Pbkdf2.verify_pass |
+| Comeonin.Pbkdf2.dummy_checkpw | Pbkdf2.no_user_verify |

lib/comeonin.ex

@@ -5,7 +5,7 @@ defmodule Comeonin do
   ## Further information
 
   Visit our [wiki](https://github.com/riverrun/comeonin/wiki)
-  for links to further information about these and related issues.
+  for links to further information.
   """
 
   @type opts :: keyword