From 14fc3ce00c9b3b4dfa55bcfd61e807fa09e29984 Mon Sep 17 00:00:00 2001 From: EGOIST <0x142857@gmail.com> Date: Mon, 19 Aug 2019 15:11:08 +0800 Subject: [PATCH] add readme --- .../saber-plugin-google-analytics/README.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 packages/saber-plugin-google-analytics/README.md diff --git a/packages/saber-plugin-google-analytics/README.md b/packages/saber-plugin-google-analytics/README.md new file mode 100644 index 000000000..6b48bc9dc --- /dev/null +++ b/packages/saber-plugin-google-analytics/README.md @@ -0,0 +1,40 @@ +# saber-plugin-google-analytics + +Add Google Analytics to your Saber sites. + +## Install + +```bash +yarn add saber-plugin-google-analytics +``` + +## Usage + +In your `saber-config.yml`: + +```yml +plugins: + - resolve: saber-plugin-google-analytics + options: + trackID: UA-XXX-XX # Google Analytics Track ID +``` + +## Plugin Options + +### trackID + +- Type: `string` +- Required: `true` + +Google Analytics Track ID. + +### anonymizeIp + +- Type: `boolean` +- Default: `false` + +To anonymize the IP address for all hits sent from a single tracker, set the `anonymizeIp` option to `true`. + +## License + +MIT.