Comparing version 0.0.2 to 0.0.3
{ | ||
"name": "nlf", | ||
"preferGlobal": true, | ||
"title": "Node License Finder", | ||
"description": "Find licenses for a node application and its node_module dependencies", | ||
"author": "Ian Kelly <iandotkelly@gmail.com>", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"license": "MIT", | ||
"bin" : { | ||
"nlf" : "./bin/nlf-cli.js" | ||
}, | ||
"homepage": "https://github.com/iandotkelly/nlf", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/iandotkelly/nlf.git" | ||
"url": "git://github.com/iandotkelly/nlf.git" | ||
}, | ||
@@ -13,0 +16,0 @@ "dependencies": { |
@@ -11,19 +11,10 @@ # Node License Finder (nlf) | ||
## Setup | ||
## Use | ||
Do this: | ||
```sh | ||
$ npm install -g nlf | ||
``` | ||
### Using | ||
nlf can be used programatically, or from the command line. | ||
## Programatically | ||
### Programatically | ||
```javascript | ||
var nlf = require('lib/nlf'); | ||
var nlf = require('nlf'); | ||
@@ -40,5 +31,14 @@ var results = nlf.find('/User/me/my-project', function (err, data) { | ||
## CLI | ||
### CLI | ||
To install: | ||
```sh | ||
$ npm install -g nlf | ||
``` | ||
To use: | ||
```sh | ||
$ cd my-module | ||
@@ -48,7 +48,24 @@ $ nlf | ||
### Tests | ||
To run the npm unit tests, install development dependencies and run tests with 'npm test' or 'make'. | ||
If you contribute to the project, tests are written in [mocha](http://visionmedia.github.com/mocha/), using [should.js](https://github.com/visionmedia/should.js/) or the node.js assert module. | ||
```sh | ||
$ cd nlf | ||
$ npm install | ||
$ npm test | ||
``` | ||
## Revision History | ||
### 0.0.3 | ||
- Attempt to resolve npm install issues | ||
### 0.0.2 | ||
- Fixed issue with asyncronous recursion over npm data that caused nlf.find() to sometimes not complete. | ||
- Fixed issue with asyncronous recursion over npm data that caused nlf.find() to sometimes not complete | ||
@@ -59,5 +76,5 @@ ### 0.0.1 | ||
### License | ||
## License | ||
The MIT License (MIT) | ||
[The MIT License (MIT)](http://opensource.org/licenses/MIT) | ||
@@ -84,5 +101,1 @@ Copyright (c) 2013 Ian Kelly | ||
[node.js]: http://nodejs.org | ||
[mocha]: http://visionmedia.github.com/mocha/ | ||
[(MIT)]: http://opensource.org/licenses/MIT | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
38132
1
97