projectDescriptionFull
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Provide code examples and explanations of how to get the project.
Let people know how they can dive into the project, include important links to things like issue trackers, IRC, Twitter accounts, etc. if applicable.
Link to CONTRIBUTING.md
, AUTHORS
, and update the contributors section in package.json
.