Skip to content

ek9/generator-license-cc

Repository files navigation

generator-license-cc

NPM version Build Status Coverage Status Dependency Status

# Generate a Creative Commons LICENSE for your Creative Work
yo license-cc

Now coming with a license chooser integrated to help you pick LICENSE!

asciicast

Install

First, install Yeoman and generator-license-cc using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-license-cc

Usage

Generate a Creative Commons LICENSE for your Creative Work:

yo license-cc

Composability with other generators

generator-license-cc can be used when composing your own generator. An example code how to trigger this generator:

this.composeWith(require.resolve('generator-license-cc/app'), {
  name: 'Bob A',                        // (optional) Author's Name
  creativeWork: 'Media & Data Files',   // (optional) Creative Work Title
  email: '[email protected]',             // (optional) Author's Email
  website: 'http://www.example.org',    // (optional) Author's Website
  year: '2016-2017',                    // (optional) Year(s) to include
  ccLicensePrompt: 'Choose a License:', // (optional) custom license prompt text
  ccLicense: 'chooser',                 // (optional) choose CC license (spdx) or 'chooser'
  output: 'docs/LICENSE'                // (optional) choose output file
});

In order to get a list of licenses supported in this generator, you can call:

require('generator-license-cc').licenses

Note: Make sure you have generator-license-cc as a dependency in your generator's package.json:

$ npm install --save generator-license-cc

For more information read Yeoman's Documentation page on Composability.

Creative Common Licenses

This generator allows you to generate LICENSE file for your project with one of Creative Commons Licenses:

Alternatively, you can pick CC0 Public Domain 1.0 to waive all copyright.

Similar Generators

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Change Log

Please see CHANGELOG for information of what was changed.

Author

Copyright (c) 2017 ek9 [email protected] (https://ek9.co)

License

This work is licensed under MIT LICENSE.