README.md

Add License Bot

Summary

If your repository does not have a file with name:

• LICENSE
• LICENSE.md
• license
• license.md

A license file will be generated from package.json.

Permission

• Read access to code.
• Read and write access to single file ("LICENSE").

Notification

The bot will mention you in a comment.

Public App

• github.com/apps/Add-License

Setup

# Install dependencies
npm install

# Run the bot
npm start

Tests

To run the test suite, first install the dependencies, then run test:

# NPM
npm test
# Or Using Yarn
yarn test

Dependencies

• choosealicense-list: List of licenses from choosealicense.com
• probot: 🤖 A framework for building GitHub Apps to automate and improve your workflow

Dev Dependencies

• jest: Delightful JavaScript Testing.
• nodemon: Simple monitor script for use during development of a node.js app.
• smee-client: Client to proxy webhooks to local host
• xo: JavaScript happiness style linter ❤️

Contributing

If you have suggestions for how Add-License-Bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Thanks

• @wmhilton - zeke/package-json-to-readme/issues/32#issuecomment-421673622

License

MIT © 2018 TiagoDanin TiagoDanin@outlook.com (http://tiagodanin.github.io/Add-License-Bot)