README.md in authtrail-0.2.0 vs README.md in authtrail-0.2.1
- old
+ new
@@ -2,10 +2,12 @@
Track Devise login activity
:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
+[![Build Status](https://travis-ci.org/ankane/authtrail.svg?branch=master)](https://travis-ci.org/ankane/authtrail)
+
## Installation
Add this line to your application’s Gemfile:
```ruby
@@ -84,11 +86,11 @@
```
Set job queue for geocoding
```ruby
-AuthTrail::GeocodeJob.queue_as :low
+AuthTrail.job_queue = :low_priority
```
### Geocoding Performance
To avoid calls to a remote API, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and configure Geocoder to use it.
@@ -110,19 +112,16 @@
)
```
## Data Protection
-Protect the privacy of your users by encrypting fields that contain personal information, such as `identity` and `ip`. [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted) is great for this. Use [blind_index](https://github.com/ankane/blind_index) so you can still query the fields.
+Protect the privacy of your users by encrypting fields that contain personal data, such as `identity` and `ip`. [Lockbox](https://github.com/ankane/lockbox) is great for this. Use [Blind Index](https://github.com/ankane/blind_index) so you can still query the fields.
```ruby
class LoginActivity < ApplicationRecord
- attr_encrypted :identity, key: ...
- attr_encrypted :ip, key: ...
-
- blind_index :identity, key: ...
- blind_index :ip, key: ...
+ encrypts :identity, :ip
+ blind_index :identity, :ip
end
```
## Other Notes
@@ -151,5 +150,14 @@
- [Report bugs](https://github.com/ankane/authtrail/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/authtrail/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/authtrail.git
+cd authtrail
+bundle install
+bundle exec rake test
+```