wayfarer - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "wayfarer",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "A simple router built for minimalism and speed",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "NODE_ENV=test ./node_modules/mocha/bin/mocha --recursive --harmony-generators -R spec",
+    "coverage": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha --report text --recursive -- -R spec && rm -rf ./coverage/"
   },
@@ -24,3 +25,12 @@ "repository": {
   },
-  "homepage": "https://github.com/yoshuawuyts/wayfarer"
+  "homepage": "https://github.com/yoshuawuyts/wayfarer",
+  "dependencies": {
+    "routington": "^0.1.3"
+  },
+  "devDependencies": {
+    "coveralls": "^2.10.0",
+    "istanbul": "^0.2.11",
+    "mocha": "^1.20.1",
+    "should": "^4.0.4"
+  }
 }

README.md

 # wayfarer
-A simple router built for minimalism and speed. WIP.
+[![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url]
 
+A simple router built for minimalism and speed. Works best with 
+[React](facebook.github.io/react) and Browserify(github.com/substack/browserify).
+
+## Installation
+```bash
+$ npm i --save wayfarer
+```
+
+## API
+```js
+var wayfarer = require('wayfarer');
+var router = wayfarer();
+
+router
+  .path('/', function() {console.log('/')})
+  .path('/home', function() {console.log('/home')})
+  .path('/404', function() {console.log('/404')})
+  .path('/:user', function() {console.log('/user')});
+```
+
 ## License
-[MIT](https://tldrlegal.com/license/mit-license) © [Yoshua Wuyts](yoshuawuyts.com)
+[MIT](https://tldrlegal.com/license/mit-license) © [Yoshua Wuyts]([e-mail])
+
+[npm-image]: https://img.shields.io/npm/v/wayfarer.svg?style=flat
+[npm-url]: https://npmjs.org/package/wayfarer
+[travis-image]: https://img.shields.io/travis/yoshuawuyts/wayfarer.svg?style=flat
+[travis-url]: https://travis-ci.org/yoshuawuyts/wayfarer
+[coveralls-image]: https://img.shields.io/coveralls/yoshuawuyts/wayfarer.svg?style=flat
+[coveralls-url]: https://coveralls.io/r/yoshuawuyts/wayfarer?branch=master

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

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

4694

increased by157.21%

Number of package files

5

increased by66.67%

Lines of code

44

increased byInfinity%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

32

increased by540%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

4

increased byInfinity%

Dependency changes

• + Addedroutington@^0.1.3

• + Addedroutington@0.1.3(transitive)