README.md in seraph-0.0.5 vs README.md in seraph-0.0.6
- old
+ new
@@ -1,6 +1,6 @@
-# seraph
+# Seraph
[![Build Status](https://travis-ci.org/Szeliga/seraph.svg?branch=master)](https://travis-ci.org/Szeliga/seraph)
[![Code Climate](https://codeclimate.com/github/Szeliga/seraph/badges/gpa.svg)](https://codeclimate.com/github/Szeliga/seraph)
[![Test Coverage](https://codeclimate.com/github/Szeliga/seraph/badges/coverage.svg)](https://codeclimate.com/github/Szeliga/seraph/coverage)
A simple framework-agnostic library for authentication. seraph provides an API for implementing User authentication inside your app. It doesn't make any assumptions about your setup, so you do not have to have a `User` class that inherits from `ActiveRecord::Base`.
@@ -60,15 +60,15 @@
As a result you get the encrypted password, which you can be persisted in the database, alongside other user data (e-mail, login, etc.)
### Comparing a provided password with the encrypted one
-Comparison is done using a constant-time secure comparison method from the gem (fast_secure_compare)[https://github.com/daxtens/fast_secure_compare]
+Comparison is done using a constant-time secure comparison method from the gem [fast_secure_compare](https://github.com/daxtens/fast_secure_compare)
To do it simply run:
``` ruby
-Seraph::Authenticator.call(encrypted_password, plaintext_password)
+Seraph::PasswordComparator.call(encrypted_password, plaintext_password)
# => true or false
```
If the pepper was set in the configuration block, it will be automatically used in the comparison.