Extended Package Data
These properties go a little farther in describing your package and what it is.
description
string
The full description of your package. Feel free to use line breaks, HTML, or football analogies.
instructions
string
Tell the user how to install and use your package.
changelog
string
A list of the changes this package has gone through.
keywords
array
List words that describe your package as an array of keywords.
license
array of objects
Let the world know what license your package is released under. This property is an array of objects where each object represents a single license. Your package can have more than once license.
The license object will have a type
and URL
key. Examples of license types are MIT, GPL, Apache 2.0, etc. A valid list of licenses might look like this:
contributors
array
Give a shout-out here to everyone who helped with your package. This is an array, and you can put strings it containing names and/or E-mail addresses, or you a objects to the array containing keys such as name
and email
.