getditto / DittoAndroidTools

Diagnostic and Debugging Tools for Ditto Android SDK
MIT License
6 stars 1 forks source link

Best practices for Heartbeat tool #97

Open texasRanger09 opened 3 months ago

texasRanger09 commented 3 months ago

Add best practices to the README for the heartbeat tool. Cover topics such as:

  1. Adding a subscription (When/why you would add this)
  2. What kind of data to add to metaData field
  3. Frequency for secondsInterval
okdistribute commented 2 months ago

Instead of the readme this content is likely best in the documentation Best Practices section. We can then link to that from this readme.

See other dev tools for an example here where more comprehensive docs are linked to, rather than trying to fit it all into a readme.

Cc @bplattenburg related to this quarter's goals