Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
riverrun committed Jan 19, 2022
1 parent 8ee684d commit 5a987f8
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 23 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,7 @@ erl_crash.dump
bcrypt_elixir-*.tar

# Temporary files for e.g. tests
/tmp
/tmp/

# priv
/priv/
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## v2.3.1 (2022-01-19)

* Changes
* Updated documentation

## v2.3.0 (2021-01-07)

* Enhancements
Expand Down
21 changes: 0 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5a987f8

Please sign in to comment.