README
Cerate read me file
Creating and adding a README.md file to a package
- In a text editor, in your package root directory, create a file called README.md.
- In the README.md file, add useful information about your package.
- Save the README.md file.
GitHub Flavored Markdown
https://guides.github.com/features/mastering-markdown/#what
The README file will only be updated on the package page when you publish a new version of your package. To update your README file:
- In a text editor, update the contents of the README.md file.
- Save the README.md file.
- On the command line, in the package root directory, run the following commands:
npm version patch
npm publish
> npm set init.author.email "example-user@example.com"
> npm set init.author.name "example_user"
> npm set init.license "MIT"