Giters

riverrun / comeonin

Password hashing specification for the Elixir programming language

Home Page:https://hex.pm/packages/comeonin

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[FEATURE] Include examples, including installation, hashing, and verifying

fireproofsocks opened this issue · comments

commented

Problem

Users would benefit if the documentation had examples including the following:

  1. Installation instructions (since this relies on comeonin AND a hashing package, it would be good to go beyond the standard blurb of what to include in your mix.exs file)
  2. Show a complete flow using at least one of the algorithms: hashing a password, then verifying it.
commented

Thanks for raising the issue. I think I need to make it clearer where all the documentation is. I will look into it further and get back to you soon.

commented

Just a quick note to let you know about the progress on this issue.

I have updated the READMEs and documentation for comeonin, argon2_elixir, bcrypt_elixir and pbkdf2_elixir. Next, I am going to add a page to the Comeonin wiki providing an example workflow, and write a blog post about the various changes in the latest version of Comeonin.

commented

Added https://github.com/riverrun/comeonin/wiki/Hashing-passwords to the wiki, and so closing this issue.