From b5b937dd103be9041f11cb799602c2854e42d92f Mon Sep 17 00:00:00 2001 From: Justin Woo Date: Sat, 12 Aug 2023 03:18:57 +0300 Subject: [PATCH] update note on allowTopLevel behavior (#62) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5b6b857..fc7e18a 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@ By default, scarf-js will only trigger analytics when your package is installed // Toggles whether Scarf is enabled for this package "enabled": true, // Enables Scarf when users run npm install directly in your repository + // Scarf will try to report the Git commit SHA of your repository if it can + // be obtained. "allowTopLevel": true, // Users will be opted into analytics by default "defaultOptIn": true,