From 782c82a40d6382cf912841e89fc5210c3bd00ac2 Mon Sep 17 00:00:00 2001 From: Matias Cabello Date: Wed, 29 Jan 2025 15:02:43 -0300 Subject: [PATCH] included telemetry documentation --- docs/docs/intro.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index f302ef29..84dff733 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -42,3 +42,16 @@ cargo scout-audit 💡 Scout supports Cargo Workspaces. When run on a workspace, Scout will be executed on all packages specified as members of the workspace. ⚠️ Make sure that your smart contracts compile properly. Scout won't run if any compilation errors exist. + +## Privacy + +Scout Audit includes telemetry to track usage, but your data remains completely secure. + +All reports sent to Scout are stored locally and can be viewed at: +`$HOME/.scout-audit/telemetry/reports` + +To disable telemetry, navigate to: +`$HOME/.scout-audit/telemetry`, open `user_id.txt`, and replace its content with DONOTTRACK. + +If you want to permanently delete your data from Scout's database, visit: +`https://scout-api.coinfabrik.com/user/delete/`. \ No newline at end of file