@todo:

• fix customPath
• tests
• travis
• snyk
• update open-source-project-template

enhancements:

• add link to license
• automate install steps
• add to setup.sh for projects that use that

License exceptions

A Node package to add a list of non-public domain Node.js modules to your project's TERMS Exceptions.

Uses the License checker tool to determine the license for your software's Node.js dependencies, and outputs the list to CFPB's standard TERMS file to be included with all of our open source software.

Dependencies

• Node.js

Installation

1. First install Node.js. Then in your project's root directory:

npm install license-exceptions --save-dev

1. Add the following script to your index.js or a custom JS file:

'use strict';

var licenseExceptions = require('license-exceptions');

licenseExceptions.init();

Usage

1. Run the script you installed:

node index.js

1. Commit the updated TERMS.md file.
2. Run anytime you update package.json.

How to test the software

If the software includes automated tests, detail how to run those tests.

Known issues

Document any known significant shortcomings with the software.

Getting help

Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.

Example

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

Getting involved

This section should detail why people should get involved and describe key areas you are currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building important pieces, etc.

General instructions on how to contribute should be stated with a link to CONTRIBUTING.

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

Credits and references

1. This project uses License checker to grab license info for your installed node modules.