Skip to content

Commit

Permalink
Updated dependencies, Added version badge, Added usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
mwittig committed May 22, 2015
1 parent 99a6b21 commit bed9cbb
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 7 deletions.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
NPM License Crawler
===================

[![npm version](https://badge.fury.io/js/npm-license-crawler.svg)](http://badge.fury.io/js/npm-license-crawler)

NPM License Crawler is a wrapper around [license-checker](https://github.com/davglass/license-checker) to analyze
several node packages (package.json files) as part of your software project. This way, it is possible to create a list
of third party licenses for your software project in one go. File paths containing ".git" or "node_modules" are ignored
Expand Down Expand Up @@ -35,6 +37,30 @@ Example
-------

npm-license-crawler --exclude ./lib/logging --dependencies --csv licenses.csv

Using npm-license-crawler programmatically
------------------------------------------

See the following example.

var crawler = require('npm-license-crawler'),
options = {
start: ['../..'],
exclude: ['.'],
json: 'licenses.json',
unknown: true
};

crawler.dumpLicenses(options,
function(error, res){
if (error) {
console.error("Error:", error);
}
else {
console.dir(res);
}
}
);

History
-------
Expand Down Expand Up @@ -76,8 +102,13 @@ History

* 20150414, V0.0.8
* Changed API of dumpLicenses() callback to improve programmatic use
* Sorting and file output are nuw done as part of dumpLicenses()
* Sorting and file output are now done as part of dumpLicenses()

* 20150423, V0.0.9
* Updated dependencies
* Added version badge
* Added usage example

Todo
----

Expand Down
26 changes: 20 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
{
"name": "npm-license-crawler",
"version": "0.0.8",
"version": "0.0.9",
"homepage": "https://github.com/mwittig/npm-license-crawler",
"description": "Analyzes license information for multiple node.js modules (package.json files) as part of your software project.",
"main": "./lib/index.js",
"bin": {
"npm-license-crawler": "./bin/npm-license-crawler"
},
"dependencies": {
"jquery-extend": "~2.0.3",
"async": "^0.9.0",
"nopt": "^3.0.1",
"mkdirp": "^0.5.0",
"async": "^1.0.0",
"nopt": "^3.0.2",
"mkdirp": "^0.5.1",
"nopt-usage": "^0.1.0",
"nopt-defaults": "^0.0.1",
"license-checker": "git+https://github.com/mwittig/license-checker"
Expand All @@ -22,7 +23,16 @@
"scripts": {
"test": "istanbul cover --print both vows --"
},
"author": "Marcus Wittig",
"author": {
"name": "Marcus Wittig",
"url": "https://github.com/mwittig/npm-license-crawler"
},
"contributors": [
{
"name": "Marcus Wittig",
"url": "https://github.com/mwittig"
}
],
"bugs": {
"url": "http://github.com/mwittig/npm-license-crawler/issues"
},
Expand All @@ -41,5 +51,9 @@
"npm",
"checker",
"crawler"
]
],
"engines": {
"node": ">0.8.x",
"npm": ">1.1.x"
}
}

0 comments on commit bed9cbb

Please sign in to comment.