readme updates

* add project image
* switch features & usage around
* add note about production mode
This commit is contained in:
Matthias Kretschmann 2018-05-08 17:59:26 +02:00
parent 370025f1ee
commit 49640f4d37
Signed by: m
GPG Key ID: 606EEEF3C479A91F
2 changed files with 13 additions and 10 deletions

View File

@ -1,11 +1,23 @@
# 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)
[![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/)
⚛️📄🚀 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
1. First, install the plugin from your project's root:
@ -32,16 +44,7 @@
3. That's it!
## Features
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
_NOTE: This plugin only generates output when run in production mode. To test your tracking code, run: `gatsby build && gatsby serve`_.
## Development

BIN
gatsby-plugin-matomo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB