README, Changelog, version bump

Shopify · Jul 18, 2017 · 6f1197f · 6f1197f
1 parent 89e5a21
commit 6f1197f
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 6 deletions.
diff --git a/.byebug_history b/.byebug_history
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+7.3.1
+-----
+* Add an after_authenticate job which will be run once the shop is authenticated. [[#431]](https://github.com/Shopify/shopify_app/pull/432)
+
 7.3.0
 -----
 * Bump required omniauth-shopify-oauth2 version to 1.2.0.

diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ Table of Contents
  * [Home Controller Generator](#home-controller-generator)
  * [App Proxy Controller Generator](#app-proxy-controller-generator)
  * [Controllers, Routes and Views](#controllers-routes-and-views)
+ * [After Authenticate Job and Generator](#after-authenticate-job-an-generator)
 * [**Mounting the Engine**](#mounting-the-engine)
 * [**Managing Api Keys**](#managing-api-keys)
 * [**WebhooksManager**](#webhooksmanager)
@@ -323,6 +324,30 @@ end
 Create your app proxy url in the [Shopify Partners' Dashboard](https://app.shopify.com/services/partners/api_clients), making sure to point it to `https://your_app_website.com/app_proxy`.
 ![Creating an App Proxy](/images/app-proxy-screenshot.png)
 
+### AfterAuthenticate Job and Generator
+
+If your app needs to perform specific actions after it is installed ShopifyApp can queue or run a job of your choosing (note that we already provide support for automatically creating Webhooks and Scripttags). To configure the after authenticate job update your initializer as follows:
+
+```ruby
+ShopifyApp.configure do |config|
+  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob }
+end
+```
+
+If you need the job to run synchronously add the `inline` flag:
+
+```ruby
+ShopifyApp.configure do |config|
+  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob, inline: true }
+end
+```
+
+We've also provided a generator which creates a skeleton job and updates the initializer for you:
+
+```
+bin/rails g shopify_app:add_after_authenticate_job
+```
+
 Troubleshooting
 ---------------
 

diff --git a/lib/shopify_app/version.rb b/lib/shopify_app/version.rb
@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '7.3.0'
+  VERSION = '7.3.1'
 end