Changeset 1395653

Timestamp:

04/14/2016 03:10:53 PM (10 years ago)

Author:

bobintercom

Message:

Warning about caches

Location:

intercom/trunk

Files:

• readme.md (modified) (2 diffs)
• readme.txt (modified) (1 diff)

intercom/trunk/readme.md

@@ -1 @@
-# Intercom / Wordpress
+# Intercom / WordPress
 
 [![Build Status](https://travis-ci.org/intercom/intercom-wordpress.svg?branch=master)](https://travis-ci.org/intercom/intercom-wordpress)
 
-# Beta
+# Compatibility
 
-This plugin for Wordpress is in active development.
+Requires PHP 5.3 or higher.
 
 # Local Testing
@@ -12 +12 @@
 
 ```php
-TEST=1 phpunit
+INTERCOM_PLUGIN_TEST=1 phpunit
 ```
+
+# Test the new version of the plugin with Intercom's Wordpress signup flow
+
+It is mandatory that you fully test the [intercom wordpress setup guide](https://app.intercom.io/a/start/wordpress) before you release a new update of the plugin.
 
 # Usage
 
-Installing this plugin provides a new Intercom settings page, which allows you to configure your app id and secure mode secret:
+Installing this plugin provides a new Intercom settings page.
+Authenticate with Intercom to retrieve your app_id and secure_mode_secret.
+<img src="https://raw.githubusercontent.com/intercom/intercom-wordpress/master/screenshots/settings_not_auth.png"/>
 
-<img src="https://raw.githubusercontent.com/intercom/intercom-wordpress/master/screenshots/settings.png"/>
+Once authenticated, if you have enabled [Acquire](https://www.intercom.io/live-chat), the Intercom widget will automatically appear on your site.
 
-Once filled out, the Intercom widget will automatically appear:
+<img src="https://raw.githubusercontent.com/intercom/intercom-wordpress/master/screenshots/settings_auth.png"/>
 
-<img src="https://raw.githubusercontent.com/intercom/intercom-wordpress/master/screenshots/widget.png"/>
+NB: This plugin injects a Javascript snippet on your website frontend containing dynamic user data. Some caching solutions will cache entire pages and should not be used with this plugin. Doing so may cause conversations to be delivered to the wrong user.
 
 # Users
 
 If a `$current_user` is present, we use their email as an identifier in the widget.
-
-Otherwise the widget operates in [Acquire mode](https://www.intercom.io/live-chat) (if available). This allows you to talk with anonymous visitors on your Wordpress site.
+We recommend to enable the [secure mode](https://docs.intercom.io/configuring-intercom/enable-secure-mode) in the settings page.
+Otherwise the widget operates in [Acquire mode](https://www.intercom.io/live-chat) (if available). This allows you to talk with anonymous visitors on your WordPress site.
 
 # Contributing

intercom/trunk/readme.txt

@@ -30 +30 @@
 If `current_user` is present, their email will be used as an identifier in the widget. Otherwise, it falls back to anonymous chat using [Acquire](https://www.intercom.io/live-chat).
 
+This plugin injects a Javascript snippet on your website frontend containing dynamic user data. Some caching solutions will cache entire pages and should not be used with this plugin. Doing so may cause conversations to be delivered to the wrong user.
+
 [View more details](https://github.com/intercom/intercom-wordpress).