Merge pull request #554 from cloudant/552-proguard-android

552 add proguard in docs

Author: emlaver

doc/events.md

@@ -62,9 +62,11 @@ For `DocumentStore` events there is a similar superclass: `DocumentStoreModified
 
 Whether to use these generic events or one method per event type is simply a matter of style.
 
-Note that subscribing methods are invoked synchronously. This means that it is important to
+Note that subscribing methods are:
+- invoked synchronously. This means that it is important to
 return quickly from the subscribing method - otherwise performance of the `Database` or
 `DocumentStore` could be impaired.
+- invoked reflectively and will need specific excludes if using ProGuard.
 
 If the subscribing method needs to start long-running tasks, we recommend you use an
 asynchronous approach such as spawning a thread and returning immediately.

sample/todo-sync/README.md

@@ -88,3 +88,6 @@ Once installed, the default settings entered in the XML file above should appear
 To test your connection, add a couple of tasks and hit "Upload (Push)" from the menu in the top right. You should see the JSON documents appear in your Cloudant database. Changes to the documents in the Cloudant database will be replicated back to the device when you tap "Download (Pull)".
 
 If you see "Replication Error" rather than "Replication Complete" as a popup message, check the logs using `adb` to see what the exception was.
+
+**Note:** If you require ProGuard and your app has a different namespace, you'll need an additional `keep` in `proguard.cfg` to preserve the `@Subscribe` methods that are reflectively invoked.
+