Fix readme

readme.md

@@ -18,6 +18,38 @@ Allow Customizer states to be drafted, and previewed with a private URL.
 Customize Snapshots save the state of a Customizer session so it can be shared or even published at a future date. A snapshot can be shared with a private URL to both authenticated and non authenticated users. This means anyone can preview a snapshot's settings on the front-end without loading the Customizer, and authenticated users can load the snapshot into the Customizer and publish or amend the settings at any time.
 
 Requires PHP 5.3+. **Development of this plugin is done [on GitHub](https://github.com/xwp/wp-customize-snapshots). Pull requests welcome. Please see [issues](https://github.com/xwp/wp-customize-snapshots) reported there before going to the [plugin forum](https://wordpress.org/support/plugin/customize-snapshots).**
+### Persistent Object Caching ###
+Plugins and themes may currently only use `is_customize_preview()` to
+decide whether or not they can store a value in the object cache. For
+example, see `Twenty_Eleven_Ephemera_Widget::widget()`. However, when
+viewing a snapshot on the frontend, the `is_customize_preview()` method
+will return `false`. Plugins and themes that store values in the object
+cache must either skip storing in the object cache when `CustomizeSnapshots\is_previewing_settings()`
+is `true`, or they should include the `CustomizeSnapshots\current_snapshot_uuid()` in the cache key.
+
+Example of bypassing object cache when previewing settings inside the Customizer preview or on the frontend via snapshots:
+
+```php
+if ( function_exists( 'CustomizeSnapshots\is_previewing_settings' ) ) {
+	$bypass_object_cache = CustomizeSnapshots\is_previewing_settings();
+} else {
+	$bypass_object_cache = is_customize_preview();
+}
+$contents = null;
+if ( ! $bypass_object_cache ) {
+	$contents = wp_cache_get( 'something', 'myplugin' );
+}
+if ( ! $contents ) {
+	ob_start();
+	myplugin_do_something();
+	$contents = ob_get_clean();
+	echo $contents;
+}
+if ( ! $bypass_object_cache ) {
+	wp_cache_set( 'something', $contents, 'myplugin', HOUR_IN_SECONDS );
+}
+```
+
 
 ## Screenshots ##
 

readme.txt

@@ -15,7 +15,7 @@ Customize Snapshots save the state of a Customizer session so it can be shared o
 
 Requires PHP 5.3+. **Development of this plugin is done [on GitHub](https://github.com/xwp/wp-customize-snapshots). Pull requests welcome. Please see [issues](https://github.com/xwp/wp-customize-snapshots) reported there before going to the [plugin forum](https://wordpress.org/support/plugin/customize-snapshots).**
 
-=== Persistent Object Caching ===
+= Persistent Object Caching =
 
 Plugins and themes may currently only use `is_customize_preview()` to
 decide whether or not they can store a value in the object cache. For
@@ -27,7 +27,7 @@ is `true`, or they should include the `CustomizeSnapshots\current_snapshot_uuid(
 
 Example of bypassing object cache when previewing settings inside the Customizer preview or on the frontend via snapshots:
 
-<pre lang=php>
+<pre lang="php">
 if ( function_exists( 'CustomizeSnapshots\is_previewing_settings' ) ) {
 	$bypass_object_cache = CustomizeSnapshots\is_previewing_settings();
 } else {