Example
{
"name": "my-project",
"version": "0.0.1",
"description": "This is a project.",
"author": "Someone <[email protected]>",
"contributors": [{
"name": "Someone Else",
"email": "[email protected]"
}],
"keywords": ["improves", "searching"]
}
Field | Description |
---|
name | a required field for a package to install. Needs to be lowercase, single word without spaces. (Dashes and underscores allowed) |
version | a required field for the package version using semantic versioning. |
description | a short description of the project |
author | specifies the author of the package |
contributors | an array of objects, one for each contributor |
keywords | an array of strings, this will help people finding your package |