1 | # generate-license [![NPM version](https://img.shields.io/npm/v/generate-license.svg?style=flat)](https://www.npmjs.com/package/generate-license) [![NPM downloads](https://img.shields.io/npm/dm/generate-license.svg?style=flat)](https://npmjs.org/package/generate-license) [![Build Status](https://img.shields.io/travis/generate/generate-license.svg?style=flat)](https://travis-ci.org/generate/generate-license)
|
2 |
|
3 | Generate a license file for a GitHub project.
|
4 |
|
5 | ## Install
|
6 |
|
7 | Install with [npm](https://www.npmjs.com/):
|
8 |
|
9 | ```sh
|
10 | $ npm install generate-license --save
|
11 | ```
|
12 |
|
13 | ## CLI
|
14 |
|
15 | Run the `license` generator from the command line:
|
16 |
|
17 | ```sh
|
18 | $ gen license
|
19 | ```
|
20 |
|
21 | ## API
|
22 |
|
23 | To use this generator programmatically, as a plugin or sub-generator, you must first install the generator locally.
|
24 |
|
25 | ### Install
|
26 |
|
27 | Install with [npm](https://www.npmjs.com/):
|
28 |
|
29 | ```sh
|
30 | $ npm install generate-license
|
31 | ```
|
32 |
|
33 | ### Usage
|
34 |
|
35 | Then use in your project:
|
36 |
|
37 | ```js
|
38 | var license = require('generate-license');
|
39 | ```
|
40 |
|
41 | **Use as a plugin**
|
42 |
|
43 | In your [generate](https://github.com/generate/generate) project:
|
44 |
|
45 | ```js
|
46 | var generate = require('generate');
|
47 | var app = generate();
|
48 |
|
49 | app.use(license());
|
50 | ```
|
51 |
|
52 | **Use as a generator plugin**
|
53 |
|
54 | In your [generate](https://github.com/generate/generate) generator:
|
55 |
|
56 | ```js
|
57 | module.exports = function(app) {
|
58 | app.use(license());
|
59 | };
|
60 | ```
|
61 |
|
62 | **Use as a sub-generator**
|
63 |
|
64 | In your [generate](https://github.com/generate/generate) generator:
|
65 |
|
66 | ```js
|
67 | module.exports = function(app) {
|
68 | // name the sub-generator whatever you want
|
69 | app.register('foo', require('generate-license'));
|
70 | };
|
71 | ```
|
72 |
|
73 | ## Contributing
|
74 |
|
75 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/generate/generate-license/issues/new).
|
76 |
|
77 | ## Building docs
|
78 |
|
79 | Generate readme and API documentation with [verb](https://github.com/verbose/verb):
|
80 |
|
81 | ```sh
|
82 | $ npm install verb && npm run docs
|
83 | ```
|
84 |
|
85 | Or, if [verb](https://github.com/verbose/verb) is installed globally:
|
86 |
|
87 | ```sh
|
88 | $ verb
|
89 | ```
|
90 |
|
91 | ## Running tests
|
92 |
|
93 | Install dev dependencies:
|
94 |
|
95 | ```sh
|
96 | $ npm install -d && npm test
|
97 | ```
|
98 |
|
99 | ## Author
|
100 |
|
101 | **Jon Schlinkert**
|
102 |
|
103 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
104 | * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
105 |
|
106 | ## License
|
107 |
|
108 | Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
|
109 | Released under the [MIT license](https://github.com/generate/generate-license/blob/master/LICENSE).
|
110 |
|
111 | ***
|
112 |
|
113 | _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 27, 2016._ |
\ | No newline at end of file |