Added 'tracking' section to README

Author: erezsh

README.md

@@ -46,6 +46,7 @@ better than MySQL.
   - [How to use from Python](#how-to-use-from-python)
 - [Technical Explanation](#technical-explanation)
   - [Performance Considerations](#performance-considerations)
+- [Anonymous Tracking](#anonymous-tracking)
 - [Development Setup](#development-setup)
 - [License](#license)
 
@@ -182,12 +183,12 @@ _<sup>*</sup> Some drivers have dependencies that cannot be installed using `pip
 
 ### Install Psycopg2
 
-In order to run Postgresql, you'll need `psycopg2`. This Python package requires some additional dependencies described in their [documentation](https://www.psycopg.org/docs/install.html#build-prerequisites). 
+In order to run Postgresql, you'll need `psycopg2`. This Python package requires some additional dependencies described in their [documentation](https://www.psycopg.org/docs/install.html#build-prerequisites).
 An easy solution is to install [psycopg2-binary](https://www.psycopg.org/docs/install.html#quick-install) by running:
 
 ```pip install psycopg2-binary```
 
-Which comes with a pre-compiled binary and does not require additonal prerequisites. However, note that for production use it is adviced to use `psycopg2`. 
+Which comes with a pre-compiled binary and does not require additonal prerequisites. However, note that for production use it is adviced to use `psycopg2`.
 
 
 # How to use
@@ -225,6 +226,8 @@ Options:
   - `-j` or `--threads` - Number of worker threads to use per database. Default=1.
   - `-w`, `--where` - An additional 'where' expression to restrict the search space.
   - `--conf`, `--run` - Specify the run and configuration from a TOML file. (see below)
+  - `--no-tracking` - data-diff sends home anonymous usage data. Use this to disable it.
+
 
 ### How to use with a configuration file
 
@@ -469,6 +472,45 @@ If you pass `--stats` you'll see e.g. what % of rows were different.
   gaps), and improvements to bypass Python/driver performance limitations when
   comparing huge amounts of rows locally (i.e. for very high `bisection_threshold` values).
 
+# Anonymous Tracking
+
+data-diff collects anonymous usage data, in order to improve the tool, and our understanding of our user base.
+
+The data is sent home once when the tool starts, and once when it ends its run.
+We do not collect any sensitive information.
+
+The collected data is limited to:
+
+- Operating System and Python version
+
+- Names of databases used (postgresql, mysql, etc.)
+
+- Sizes of tables used, elapsed run time, and diff count. (numbers only)
+
+- Error message, if any, truncated to the first 20 characters.
+
+- A persistent UUID to indentify the session, stored in `~/.datadiff.toml`
+
+If you do not wish to participate, it can be easily disabled.
+
+## Disable
+
+There are several ways to disable the tracking.
+
+In the CLI, use the `--no-tracking` flag.
+
+In the config file, set `no_tracking = true` (for example, under `[run.default]`)
+
+If you're using the Python API, do the following:
+
+```python
+import data_diff
+data_diff.disable_tracking()    # Call this first, before making any API calls
+
+# Connect and diff your tables without any tracking
+```
+
+
 # Development Setup
 
 The development setup centers around using `docker-compose` to boot up various

data_diff/__init__.py

@@ -1,5 +1,6 @@
 from typing import Tuple, Iterator, Optional, Union
 
+from .tracking import disable_tracking
 from .databases.connect import connect
 from .diff_tables import (
     TableSegment,

data_diff/__main__.py

@@ -83,7 +83,7 @@ def _get_schema(pair):
 @click.option("--json", "json_output", is_flag=True, help="Print JSONL output for machine readability")
 @click.option("-v", "--verbose", is_flag=True, help="Print extra info")
 @click.option("-i", "--interactive", is_flag=True, help="Confirm queries, implies --debug")
-@click.option("--no-tracking", is_flag=True, help="Disable anonymous tracking.")
+@click.option("--no-tracking", is_flag=True, help="data-diff sends home anonymous usage data. Use this to disable it.")
 @click.option(
     "--case-sensitive",
     is_flag=True,