develephant / cya

Instant and Elegant LICENSE and README files from your package.json. Looks great in a repo, or anywhere that speaks Markdown.

cya

Generate a "pretty" license from your package.json. Looks great in a repo, or anywhere that speaks Markdown.

This README.md and the LICENSE.md were generated by cya

---

Install

npm i @develephant/cya --global

Usage

cya [ARGS]

Example

Generate a "pretty" markdown LICENSE.md file based on keys from the root package.json file.

cya

Or, generate the LICENSE.md and a README.md file stub:

cya -r

Typical Workflow

//create your package.json
npm init

//generate a license and readme
cya -r

Overrides/Help

cya -h

You can find more details in the Wiki

Licenses Supported

SPDX	Name
Apache-2.0	Apache License 2.0
BSD-2-Clause	2-clause BSD License
BSD-3-Clause	3-clause BSD License
GPL-2.0	GNU General Public License version 2
GPL-3.0	GNU General Public License version 3
ISC	ISC License
MIT	MIT License
MPL-2.0	Mozilla Public License 2.0
Zlib	zlib/libpng license

https://opensource.org/licenses/alphabetical

^_^

---

cya ⋆ © 2017 develephant ⋆ MIT license

cya's Issues

global tag not rendering

Check gate for --global