Skip to main content

What to include in every node module

All that is required to publish a node module is a package.json file with a few fields. However, there are more components to a good package.

Here are a few things to include in every node module that you publish:

README.md

A README contains all the information necessary to use your node module. They come in all shapes and sizes: decorated, detailed, and simple. But they all need to include a one important detail: how to use the package.

There are many ways to create a good README, I like the format set out by “Make a README”.



About the author

Sean McPherson is a software engineer for Khan Academy who specializes in web and mobile app development. He lives with his wife, sons, and dog in Pittsburgh, PA.