README.md in inboxable-0.1.1 vs README.md in inboxable-0.1.2

- old
+ new

@@ -78,12 +78,14 @@ - `processor_name`: This option is used to specify the name of the processor. An example of a processor name is `user_update_job`. ## Inbox Model -The Inbox model is used to store the messages in the inbox. The Inbox model is generated by the gem when you run the `rails g inboxable:install --orm <orm>` command. Based on the ORM that you are using, the gem will generate the appropriate model. The following is the structure of the Inbox model for ActiveRecord and Mongoid. +The Inbox model is used to store the messages in the inbox. The Inbox model is generated by the gem when you run the `rails g inboxable:install --orm <orm>` command. Based on the ORM that you are using, the gem will generate the appropriate model.The following is the structure of the Inbox model for ActiveRecord and Mongoid. +If you would like to use a different name for the Inbox model. You can configure it by setting the `inbox_model` config to the name of you custom defined model. See the [Configuration](#configuration) section below for more information. + ### Fields & Attributes The Inbox model has the following fields and attributes: --- @@ -121,10 +123,11 @@ The Inboxable gem provides a number of configuration options that can be used to customize the behavior of the gem. The following is a list of the configuration options that are available. --- | Option | Description | Default Value | Applied To | | --- | --- |------------------|---| -| `orm` | The ORM that is used in the application. | `:active_record` | `/config/initializers/inboxable.rb` | +| `orm` | The ORM that is used in the application. | `:active_record` | `/config/initializers/z_inboxable.rb` | +| `inbox_model` | The name of the Inbox model. | `Inbox` | `/config/initializers/z_inboxable.rb` | |`INBOXABLE__CRON_POLL_INTERVAL` | The interval in seconds between each poll of the inbox. | `5` | Can be overridden by providing an environment variable with the same name. | |`INBOXABLE__CRON` | The cron expression that is used to poll the inbox. | `*/5 * * * * *` | Can be overridden by providing an environment variable with the same name. | |`INBOXABLE__BATCH_SIZE` | The number of messages to be processed in each batch. | `100` | Can be overridden by providing an environment variable with the same name. | |`INBOXABLE__MAX_ATTEMPTS` | The maximum number of attempts to process a message. | `3` | Can be overridden by providing an environment variable with the same name. | |`INBOXABLE__RETRY_DELAY_IN_SECONDS` | The delay in seconds before retrying to process a message. | `5` | Can be overridden by providing an environment variable with the same name. |