Skip to content

Commit

Permalink
REAMDE updates & cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
inolasco committed Jan 31, 2016
1 parent d8846ea commit acde82a
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .bowerrc
@@ -1,3 +1,3 @@
{
"directory": "components"
"directory": "bower_components"
}
3 changes: 1 addition & 2 deletions .gitignore
@@ -1,6 +1,5 @@
/node_modules
/components
/dist
/bower_components
/*.sublime-*
npm-debug.log
.idea
Expand Down
4 changes: 4 additions & 0 deletions .npmignore
@@ -0,0 +1,4 @@
example
bower_components
.tm_properties
Gruntfile.js
18 changes: 13 additions & 5 deletions README.md
@@ -1,10 +1,15 @@
# angulartics-piwik

[![Bower version](https://badge.fury.io/bo/angulartics-piwik.svg)](https://badge.fury.io/bo/angulartics-piwik)

Provides piwik analytics support for [angulartics](http://angulartics.github.io)
Piwik plugin for [angulartics](http://angulartics.github.io)

## Install

First make sure you've read installation and setup instructions for [Angulartics](https://github.com/angulartics/angulartics#install).

Then you can install this package either with `npm` or with `bower`.

### npm

```shell
Expand All @@ -13,13 +18,16 @@ npm install angulartics-piwik

### Bower

```
```shell
bower install angulartics-piwik
```
Add the `<script>` to your `index.html`:

## Setup
```html
<script src="/bower_components/angulartics-piwik/dist/angulartics-piwik.min.js"></script>
```

Add `angulartics.piwik` to your module
Then add `angulartics.piwik` to your module

angular.module('myApp', ['angulartics', 'angulartics.piwik'])

Expand Down Expand Up @@ -69,7 +77,7 @@ Default angulartics page and event tracking

### Unsupported angulartics trackers

The following angulartics tracker functions have no piwik equivalent, and as such, are not supported.
The following angulartics tracker functions have no piwik equivalent, and as such, are not supported. You can use `setCustomVariable()` with a `'visit'` scope for per-user properties

$analytics.setAlias(alias)
$analytics.setUserProperties(properties)
Expand Down
16 changes: 15 additions & 1 deletion bower.json
@@ -1,9 +1,23 @@
{
"name": "angulartics-piwik",
"description": "Piwik plugin for Angulartics",
"version": "1.0.0",
"authors": [
"Ivan Nolasco <ivan.nolasco@me.com>"
],
"license": "MIT",
"main": [
"src/angulartics-piwik.js"
],
"ignore": [
"**/.*",
"bower_components",
"node_modules",
"test",
"example",
"package.json",
"Gruntfile.js"
],
"dependencies": {
"angular": ">= 1.1.5",
"angulartics": "*"
Expand All @@ -16,4 +30,4 @@
"resolutions": {
"angular": ">= 1.1.5"
}
}
}
7 changes: 7 additions & 0 deletions dist/angulartics-piwik.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "angulartics-piwik",
"description": "Piwik analytics plugin for angulartics",
"description": "Piwik plugin for Angulartics",
"version": "1.0.0",
"filename": "./src/angulartics-piwik.min.js",
"main": "./src/angulartics-piwik.js",
Expand All @@ -27,6 +27,9 @@
"url": "https://github.com/angulartics/angulartics-piwik/issues"
},
"license": "MIT",
"peerDependencies": {
"angulartics": "*"
},
"devDependencies": {
"grunt": "^0.4.5",
"grunt-bump": "0.0.15",
Expand All @@ -43,4 +46,4 @@
"karma-phantomjs-launcher": "^0.1.4",
"phantomjs": "^1.9.7-15"
}
}
}
File renamed without changes.

0 comments on commit acde82a

Please sign in to comment.