mirror of
https://github.com/kremalicious/gatsby-plugin-matomo.git
synced 2024-12-22 17:23:23 +01:00
readme updates
* add project image * switch features & usage around * add note about production mode
This commit is contained in:
parent
370025f1ee
commit
49640f4d37
23
README.md
23
README.md
@ -1,11 +1,23 @@
|
|||||||
# gatsby-plugin-matomo
|
# gatsby-plugin-matomo
|
||||||
|
|
||||||
|
![gatsby-plugin-matomo](gatsby-plugin-matomo.png)
|
||||||
[![npm package](https://img.shields.io/npm/v/gatsby-plugin-matomo.svg)](https://www.npmjs.com/package/gatsby-plugin-matomo)
|
[![npm package](https://img.shields.io/npm/v/gatsby-plugin-matomo.svg)](https://www.npmjs.com/package/gatsby-plugin-matomo)
|
||||||
[![Build Status](https://travis-ci.com/kremalicious/gatsby-plugin-matomo.svg?branch=master)](https://travis-ci.com/kremalicious/gatsby-plugin-matomo)
|
[![Build Status](https://travis-ci.com/kremalicious/gatsby-plugin-matomo.svg?branch=master)](https://travis-ci.com/kremalicious/gatsby-plugin-matomo)
|
||||||
[![Greenkeeper badge](https://badges.greenkeeper.io/kremalicious/gatsby-plugin-matomo.svg)](https://greenkeeper.io/)
|
[![Greenkeeper badge](https://badges.greenkeeper.io/kremalicious/gatsby-plugin-matomo.svg)](https://greenkeeper.io/)
|
||||||
|
|
||||||
⚛️📄🚀 Gatsby plugin to add [Matomo](https://matomo.org) (formerly Piwik) onto a site.
|
⚛️📄🚀 Gatsby plugin to add [Matomo](https://matomo.org) (formerly Piwik) onto a site.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Plugin uses sensible defaults prioritizing user experience & privacy:
|
||||||
|
|
||||||
|
- include tracking code in all server-side rendered routes
|
||||||
|
- track all route views as custom events
|
||||||
|
- load tracking scripts at end of `body` tag
|
||||||
|
- use image tracking fallback for `noscript`
|
||||||
|
- don't load anything when visitor has Do Not Track enabled
|
||||||
|
- don't load anything in non-production environments
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
1. First, install the plugin from your project's root:
|
1. First, install the plugin from your project's root:
|
||||||
@ -32,16 +44,7 @@
|
|||||||
|
|
||||||
3. That's it!
|
3. That's it!
|
||||||
|
|
||||||
## Features
|
_NOTE: This plugin only generates output when run in production mode. To test your tracking code, run: `gatsby build && gatsby serve`_.
|
||||||
|
|
||||||
Plugin uses sensible defaults prioritizing user experience & privacy:
|
|
||||||
|
|
||||||
- include tracking code in all SSR routes
|
|
||||||
- track all route views as custom events
|
|
||||||
- load tracking scripts at end of `body` tag
|
|
||||||
- use image tracking fallback for `noscript`
|
|
||||||
- don't load anything when visitor has Do Not Track enabled
|
|
||||||
- don't load anything in non-production environments
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
BIN
gatsby-plugin-matomo.png
Normal file
BIN
gatsby-plugin-matomo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 31 KiB |
Loading…
Reference in New Issue
Block a user