JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 19
  • Score
    100M100P100Q62664F
  • License MIT

An open source license generator.

Package Exports

  • lice

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lice) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

#lice

An open source license generator and license viewer.

NPM

Build status

##Installation

npm install -g lice

##Usage

lice
# follow the prompts

##CLI mode

Usage:
  lice [options]

Options:
  -h, --help     Display the help menu
  -g, --generate Generate a license [default `true`]
  -l, --license  The type of license to generate, [default `mit`]
  -n, --name     The name of the generated license, [default `LICENSE`]
  -p, --path     License generation file path, [default `current working dir`]
  -s, --show     Show the contents of a license
  -u, --user     The name to use in the generated license
  -v, --version  Display the version
  -y, --year     Year placeholder [default `current year`]

Available licenses:
  afl-3.0  Academic Free License 3.0 (AFL-3.0)
  agpl-3.0 GNU Affero General Public License 3.0 (AGPL-3.0)
  gpl-3.0  GNU General Public License 3.0 (GPL-3.0)
  isc      ISC License (ISC)
  mit      The MIT License (MIT) [default]

##Example

Let's say you want an MIT license for your project. Switch to the directory where you want the license generated, run lice and follow the prompts:

cd /your/project/dir
lice
#follow the prompts, your license will be generated in /your/project/dir

Or if you prefer CLI mode:

lice -g -l mit -u 'John Doe' # see above for flag definitions or run `lice -h`

###Note You can also provide a path to where you want the license generated via the -p option.

##Contributing

Please help add more licenses! Submit a PR and I will get it merged ASAP.

  1. Add a text file with your license content in the licenses dir.
  2. Edit licenses.js
  3. Update the Available licenses section in README.md
  4. Update the help file Available licenses section in help.txt

A good place to find licenses to add is the Open Source Initiative license page

##Thanks

Open Source Initiative for providing the license content.