docs: Analytics addition to readme

README.md

@@ -1,6 +1,8 @@
 # Flank [![Build Status](https://app.bitrise.io/app/9767f3e19047d4db/status.svg?token=uDM3wCumR2xTd0axh4bjDQ&branch=master)](https://app.bitrise.io/app/9767f3e19047d4db) [![codecov](https://codecov.io/gh/Flank/flank/branch/master/graph/badge.svg)](https://codecov.io/gh/Flank/flank) [![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)
 
-Flank is a [massively parallel Android and iOS test runner](https://docs.google.com/presentation/d/1goan9cXpimSJsS3L60WjljnFA_seUyaWb2e-bezm084/edit#slide=id.p1) for [Firebase Test Lab](https://firebase.google.com/docs/test-lab/).
+Flank is a [massively parallel Android and iOS test runner](https://docs.google.com/presentation/d/1goan9cXpimSJsS3L60WjljnFA_seUyaWb2e-bezm084/edit#slide=id.p1) for [Firebase Test Lab](https://firebase.google.com/docs/test-lab/). 
+
+Flank is YAML compatible with the gcloud CLI and has extra features for performance and stability. It provides testing features to accelerate velocity and quality.
 
 ## Download
 

docs/analytics.md

@@ -0,0 +1,22 @@
+# Flank Analytics
+
+Flank makes use of Bugsnag as its only analytics platform. It uses Bugsnag as an error monitor and project stability tool.
+
+For more information about Bugsnag please visit its website [here](https://www.bugsnag.com/) and documentation [here](https://docs.bugsnag.com/)
+
+## Control
+
+It is possible to disable the Bugsnag analytics integration used by flank or to make use of custom Bugsnag key so that any analytics can be displayed for custom use.
+
+ - To disable, place the word ```DISABLED``` in the file ````~/.gsutil/analytics-uuid```` and Flank will no longer send any analytics data
+   - Or simply running the following code (make sure the file exists!) will disable: ```echo "DISABLED" > ~/.gsutil/analytics-uuid```
+
+ - To enable or reenable bugsnag simply remove the file ```~/.gsutil/analytics-uuid``` and the project will default to make use of the flanks Bugsnag key
+
+ - To make use of custom Bugsnag integration, place your bugsnag key/UUID in ```~/.gsutil/analytics-uuid``` and the flank project will make use of it instead of the default key.
+
+ ## More information
+
+ To see how Bugsnag integration is used within the project please see the Flank Bugsnag testcase [here](../test_runner/src/test/kotlin/ftl/util/FlankBugsnagInitHelperTest.kt)
+
+

docs/readme.md

@@ -75,6 +75,10 @@ Client may be generated manually using `testing_v1.json` and the master branch o
 
 - `gradle build`
 
+## Analytics
+
+Flank makes use of various analytics. For more information on what they are and how to control them please see [analyitics.md](analytics.md)
+
 ## Mock Servers
 
 API Discovery JSON may be converted to OpenAPI 3 using [apimatic.io/transformer](https://apimatic.io/transformer). See [mock_server.md](mock_server.md) for details.

release_notes.md

@@ -1,5 +1,5 @@
 ## next (unreleased)
--
+- [#987](https://github.com/Flank/flank/pull/987) Analytics readme addition ([sloox](https://github.com/Sloox))
 -
 
 ## v20.08.1