README.md in active_job_channel-0.0.2 vs README.md in active_job_channel-0.0.3

@@ -1,68 +1,101 @@
-# `ActiveJobChannel`
-Uses `ActionCable` to alert front-end users of finished `ActiveJobs`
+# ActiveJobChannel
+Use ActionCable to alert front-end users of finished ActiveJobs
 
 ## Installation
 1. Install in your Gemfile
 
     ```ruby
     gem 'active_job_channel'
     ```
 
-2. Setup an [`ActionCable` subscription adapter](http://edgeguides.rubyonrails.org/action_cable_overview.html#subscription-adapter)
+## Setup
+1. [Create ActionCable Connection](#create-actioncable-connection-optional) (optional)
+2. [Enable ActiveJobChannel for a job](#enable-activejobchannel-for-a-job)
+3. [Handle ActiveJobChannel broadcasts](#handle-activejobchannel-broadcasts)
+
+### Create ActionCable Connection (optional)
+
+You can skip this step if you're not concerned with authorizing or brodcasting 
+privately to ActionCable connections
+
+1. Setup an [ActionCable subscription adapter](http://edgeguides.rubyonrails.org/action_cable_overview.html#subscription-adapter)
     * Note: A persisted subscription adapter is required for handling notifications
-    from background `ActiveJob` processes. Currently only PostgreSQL and Redis
+    from background ActiveJob processes. Currently only PostgreSQL and Redis
     are supported.
+2. Follow the [official guide for setting up an ActionCable Connection](http://guides.rubyonrails.org/action_cable_overview.html#server-side-components-connections)
+3. If you would like notifications broadcast privately to ActionCable 
+    connections, set up a connection identifier for your connection using 
+    `identified_by`. The identifier you use will also need to be passed to your 
+    job.
 
-3. (Optional) If you need authorization for notifications, [set up your own
-    `ApplicationCable::Connection`](http://guides.rubyonrails.org/action_cable_overview.html#server-side-components-connections)
+### Enable ActiveJobChannel for a job
+1. For each job you'd like to be notified about, call `active_job_channel` in 
+    its class
+2. To broadcast notifications privately, set the identifier you configured in
+    your ActionCable Connection setup to either the instance variable 
+    `@ajc_identifier` or the method `ajc_identifier`
 
-3. Include `active_job_channel.js` in your layouts
+```ruby
+class MyJob < ActiveJob::Base
+  active_job_channel
 
+  def perform(current_user)
+    @ajc_identifier = current_user
+  end
+
+  private
+
+  # def ajc_identifier
+  #   User.find_by(key: value)
+  # end
+end
+```
+
+#### Configuration
+
+##### global_broadcast
+
+Notifications will be broadcast to `ajc_identifier` by default. To broadcast
+all notifications for a job to all ActionCable connections, pass 
+`{ global_broadcast: true }` to `active_job_channel`.
+
+### Handle ActiveJobChannel broadcasts
+
+1. Include `active_job_channel.js` in your layouts
+
     ```ruby
     javascript_include_tag 'active_job_channel'
     ```
 
     or include it in your `app/assets/javascripts/application.js`
 
     ```javascript
       //= require active_job_channel
     ```
 
-## Usage
-For each job you'd like to be notified about, enable `active_job_channel`
+2. Customize the callbacks for broadcasted notifications:
 
-```ruby
-class MyJob < ActiveJob::Base
-  active_job_channel
-end
-```
+    ```javascript
+    //= require notifyjs
 
-To customize the client-side notification, define `ActiveJobChannel.received`
-after including `active_job_channel.js`. The current default simply logs the 
-job status to the javascript console.
+    ActiveJobChannel.onJobSuccess = function(job) { $.notify(job.name + ' succeeded!') }; 
+    ActiveJobChannel.onJobFailure = function(job) { $.notify(job.name + ' failed!') };
+    ```
 
-```javascript
-  //= require notifyjs
-  //= require active_job_channel
+    `job` has the attributes `name` and `status`. A failed `job` includes an 
+    `error` attribute. `status` is one of `success` or `failure`. 
 
-  ActiveJobChannel.received = function(data) {
-    var status = data.status;
-    var job_name = data.job_name;
-    if (status === 'success') { $.notify(job_name + ' succeeded!') }
-    else if (status === 'failure') { $.notify(job_name + ' failed!') }
-  }
-```
 
 ## Caveats
-`ActiveJobChannel` depends on `ActiveJob` and `ActionCable`, and, as such, is
+ActiveJobChannel depends on ActiveJob and ActionCable, and, as such, is
 subject to their limitations:
 
 * A persisted [subscription adapter](http://guides.rubyonrails.org/action_cable_overview.html#subscription-adapter)
-is required for `ActionCable` to handle notifications from background 
-`ActiveJob` processes
-* Because `ActiveJob` does not know when a job has permanently failed, 
-`ActiveJobChannel` sends notfications for each failure, retried or final
+is required for ActionCable to handle notifications from background 
+ActiveJob processes
+* Because ActiveJob does not know when a job has permanently failed, 
+ActiveJobChannel sends notfications for each failure, retried or final
 
 ## Todo
 - Better default front-end notification behavior
 
 ## License