gulp-mixpanel - npm Package Compare versions

Comparing version 0.2.0 to 1.0.0

package.json

 {
   "name": "gulp-mixpanel",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "Adds mixpanel analytics into your html file",
@@ -33,4 +33,5 @@ "main": "index.js",
     "event-stream": "^3.3.1",
+    "mocha": "^2.2.5",
     "vinyl": "^0.5.0"
   }
 }

README.md

@@ -0,2 +1,50 @@
+[![Build Status](https://travis-ci.org/andreydrebot/gulp-mixpanel.svg?branch=master)](https://travis-ci.org/andreydrebot/gulp-mixpanel) [![npm version](https://badge.fury.io/js/gulp-mixpanel.svg)](http://badge.fury.io/js/gulp-mixpanel)
+
 # gulp-mixpanel
-Adds mixpanel analytics into your html file
+> Adds mixpanel analytics into your html file
+
+## Usage
+
+
+#### Install
+
+```bash
+npm install gulp-mixpanel --save-dev
+```
+
+## Example
+
+```js
+var gulp = require('gulp');
+var mixpanel = require('gulp-mixpanel');
+
+gulp.task('mixpanel', function(){
+  gulp.src('./index.html')
+  .pipe(mixpanel('MY_TOKEN'))
+  .pipe(gulp.dest('./'));
+});
+```
+
+## LICENSE
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrey Drebot <[e-mail]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7446

increased by31.93%

Number of package files

8

increased by14.29%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

51

increased by1600%

Worsened metrics

Dev dependency count

3

increased by50%

No dependency changes