README.md in acts_as_encryptable-0.1.0 vs README.md in acts_as_encryptable-0.1.1
- old
+ new
@@ -1,22 +1,28 @@
# ActsAsEncryptable
+[](https://badge.fury.io/rb/acts_as_encryptable)
+[](https://travis-ci.org/danielpclark/acts_as_encryptable)
-This gem add support for ActiveSupports existing message encryption feature
-and allows you to set any ActiveRecord model as an encrypted field.
+This gem adds support with ActiveSupport's existing message encryption
+and allows you to set any ActiveRecord model column as an encrypted field.
+It's bloat free and easy to use. This way you're up to date on security as
+long as Rails is. And there's no high maintenance or feature bloat like
+other "encryption helper gems" have 😉 . It's fully tested too!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'acts_as_encryptable'
```
-And create an initializer file `config/initializers/acts_as_encryptable.rb`
+And create an initializer file:
```ruby
+# config/initializers/acts_as_encryptable.rb
ActiveRecord::Base.extend ActsAsEncryptable
```
And then execute:
@@ -43,14 +49,14 @@
"example salt" # Some consistent/secure way to derive the salt
end
end
```
-If you're encrypting multiple fields you may choose to use to alter what keys
-and salts are used per column but this will add a performance hit for the extra
+If you're encrypting multiple fields you may choose to vary what keys and salts
+are used per column, but this will add a performance hit for the extra
encryption startup time.
-If you want to perform additional work on record data that you want to encrypt
+If you want to perform additional work on record data that you want to encrypt;
write a method alias after the `acts_as_encryptable` decleration and have your
new method call it. `acts_as_encryptable` should always be written before any
method aliasing.
```ruby