/license-me

Create a license for your project

Primary LanguageTypeScriptMIT LicenseMIT

license-me Build Status

Create a license for your project

Install

$ yarn add license-me

Usage

const licenseMe = require('license-me')

licenseMe('mit', 'Bu Kinoshita', { year: 2019 })
// => License created!

API

licenseMe(name, type, [options])

returns a promise.

name

Type: string
Required

Your name

type

Type: string
Options: MIT, Apache License 2.0, GNU AGPLv3, GNU GPLv3, GNU LGPLv3, Mozilla Public License 2.0, The Unlicense
Required

License type

options

Type: object

year

Type: string
Required

email

Type: string

Personal email (only MIT License uses it)

website

Type: string

Personal website (only MIT License uses it)

License year

Related

License

MIT © Bu Kinoshita