From 5a987f89af6f6f42acf350b094a05959759c96dd Mon Sep 17 00:00:00 2001 From: David Whitlock Date: Wed, 19 Jan 2022 11:34:47 +0700 Subject: [PATCH] update README --- .gitignore | 5 ++++- CHANGELOG.md | 5 +++++ README.md | 21 --------------------- mix.exs | 2 +- 4 files changed, 10 insertions(+), 23 deletions(-) diff --git a/.gitignore b/.gitignore index 4d0dac9..d877cf1 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,7 @@ erl_crash.dump bcrypt_elixir-*.tar # Temporary files for e.g. tests -/tmp +/tmp/ + +# priv +/priv/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 2781b43..b9f22d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## v2.3.1 (2022-01-19) + +* Changes + * Updated documentation + ## v2.3.0 (2021-01-07) * Enhancements diff --git a/README.md b/README.md index 8bf41fe..c3afc2d 100644 --- a/README.md +++ b/README.md @@ -19,20 +19,6 @@ This version is based on the OpenBSD version of Bcrypt and supports the `$2b$` and `$2a$` prefixes. For advice on how to use hashes with the `$2y$` prefix, see [this issue](https://github.com/riverrun/comeonin/issues/103). -## Changes in version 2 - -In version 2.0, bcrypt_elixir has been updated to implement the Comeonin -and Comeonin.PasswordHash behaviours. - -It now has the following two additional convenience functions: - -* `add_hash/2` - * same as `Comeonin.Bcrypt.add_hash/2` in Comeonin version 4 - * hashes a password and returns a map with the password hash -* `check_pass/3` - * same as `Comeonin.Bcrypt.check_pass/3` in Comeonin version 4 - * takes a user struct and password as input and verifies the password - ## Installation 1. Add `:bcrypt_elixir` to the `deps` section of your `mix.exs` file: @@ -86,13 +72,6 @@ There are many ways you can contribute to the development of this library, inclu * Reporting issues * Improving documentation * Sharing your experiences with others -* [Making a financial contribution](#donations) - -## Donations - -First of all, I would like to emphasize that this software is offered -free of charge. However, if you find it useful, and you would like to -buy me a cup of coffee, you can do so at [PayPal](https://www.paypal.me/alovedalongthe). ### Documentation diff --git a/mix.exs b/mix.exs index 40ff3f8..c2a9cc4 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule BcryptElixir.Mixfile do use Mix.Project @source_url "https://github.com/riverrun/bcrypt_elixir" - @version "2.3.0" + @version "2.3.1" @description """ Bcrypt password hashing algorithm for Elixir