Adding proper installation instructions for your plugin in README.md file is important since it gives clear instructions to the user on how to use this plugin.

Content of README.md appears both on NPM page of your plugin as well as the github repository page.

You can use this checklist to see what needs to be included

What problem your plugin solves? How do I install it? How do I use/interact with it? Which license is applied? Optionally you can include these as well.

Some examples of how the plugin works? How does it work? Project status: builds/tests? How can I contribute? Which technologies have been used? #LICENSE.md You may also want to add a license file to your plugin since you are distributing it through open source. Creating a license file is simple.

Go to your Github repository and choose the option to create a new file.

Name the file License.md , it should give you an option to choose the license template

new MIT license github I have used MIT license template for this project.

Commit the new file.