https://github.com/tiagodanin/add-license-bot

Generate LICENSE file from package.json
https://github.com/tiagodanin/add-license-bot

github-app github-bot license probot probot-app

Last synced: 3 months ago
JSON representation

Generate LICENSE file from package.json

• Host: GitHub
• URL: https://github.com/tiagodanin/add-license-bot
• Owner: TiagoDanin
• License: mit
• Archived: true
• Created: 2018-10-16T14:29:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-03T16:57:25.000Z (11 months ago)
• Last Synced: 2024-09-26T08:02:24.650Z (3 months ago)
• Topics: github-app, github-bot, license, probot, probot-app
• Language: JavaScript
• Homepage: https://tiagodanin.github.io/Add-License-Bot/
• Size: 698 KB
• Stars: 6
• Watchers: 5
• Forks: 2
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Add License Bot

[![Travis](https://img.shields.io/travis/TiagoDanin/Add-License-Bot.svg?branch=master&style=flat-square)](https://travis-ci.org/TiagoDanin/Add-License-Bot) [![Downloads](https://img.shields.io/npm/dt/add-license-bot.svg?style=flat-square)](https://npmjs.org/package/add-license-bot) [![Node](https://img.shields.io/node/v/add-license-bot.svg?style=flat-square)](https://npmjs.org/package/add-license-bot) [![Version](https://img.shields.io/npm/v/add-license-bot.svg?style=flat-square)](https://npmjs.org/package/add-license-bot) [![XO code style](https://img.shields.io/badge/code%20style-XO-red.svg?style=flat-square)](https://github.com/xojs/xo)

![image](https://user-images.githubusercontent.com/5731176/48219879-8dd01e80-e36c-11e8-9d5f-d0c386343cf7.png)

## 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](https://github.com/apps/Add-License)

## Setup

```sh

# Install dependencies

npm install

# Run the bot

npm start

```

## Tests

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

```sh

# NPM

npm test

# Or Using Yarn

yarn test

```

## Dependencies

- [choosealicense-list](https://ghub.io/choosealicense-list): List of licenses from choosealicense.com

- [probot](https://ghub.io/probot): 🤖 A framework for building GitHub Apps to automate and improve your workflow

## Dev Dependencies

- [jest](https://ghub.io/jest): Delightful JavaScript Testing.

- [nodemon](https://ghub.io/nodemon): Simple monitor script for use during development of a node.js app.

- [smee-client](https://ghub.io/smee-client): Client to proxy webhooks to local host

- [xo](https://ghub.io/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](CONTRIBUTING.md).

## Thanks

- [@wmhilton](https://github.com/wmhilton) - [zeke/package-json-to-readme/issues/32#issuecomment-421673622](https://github.com/zeke/package-json-to-readme/issues/32#issuecomment-421673622)

## License

[MIT](LICENSE) © 2018 TiagoDanin  (http://tiagodanin.github.io/Add-License-Bot)