Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
* add project image
* switch features & usage around
* add note about production mode
  • Loading branch information
kremalicious committed May 8, 2018
1 parent 370025f commit 49640f4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down
Binary file added gatsby-plugin-matomo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 49640f4

Please sign in to comment.