README.md in po_box-0.1.0 vs README.md in po_box-0.1.1
- old
+ new
@@ -2,12 +2,12 @@
PoBox is a Ruby on Rails engine that provides inboxes and email addresses for your users.
## Requirements
-1. [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) needs to be installed and configured.
-2. [ActionMailbox](https://edgeguides.rubyonrails.org/action_mailbox_basics.html) needs to be installed and configured.
+1. [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) needs to be configured.
+2. [ActionMailbox](https://edgeguides.rubyonrails.org/action_mailbox_basics.html) needs to be configured.
3. A model that the inbox and emails will be associated with needs to exist in the host application. e.g. `User` or `Account`.
## Installation
Add this line to your application's Gemfile:
@@ -31,11 +31,11 @@
## Configuration
**IMPORTANT:** Make sure you have ActiveStorage and ActionMailbox installed and configured.
1. `bin/rails po_box:install:migrations`
-2. `bin/rails g po_box emailable_model` (where `emailable_model` is the name of the model you want to make emailable, e.g. `user`)
+2. `bin/rails g po_box emailable_model` (where `emailable_model` is the name of the model in your application you want to associate inboxes and email addresses to, e.g. `user`)
3. `bin/rails db:migrate`
4. `bin/rails po_box:backfill_emailables`
## Limitations
@@ -48,10 +48,10 @@
Send the email to the address that is associated with the emailable model. e.g.
```ruby
User.inboxes.first.address
- # => "some#64b0@yourapp"
+ # => "some#64b0@yourapp.com"
```
<!-- If your emailable_class is a User -->
```ruby