Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>Package to ReadmeNew to Visual Studio Code? Get it now.
Package to Readme

Package to Readme

anthony-y

|
3,433 installs
| (2) | Free
Parses your npm package.json and generates a markdown readme file.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Package to Readme

Parses your package.json and generates a README.md based off of it.

Usage

  1. Ctrl + P
  2. Type 'create readme'

License

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
    claim that you wrote the original software. If you use this software
    in a product, an acknowledgment in the product documentation would be
    appreciated but is not required.
2.  Altered source versions must be plainly marked as such, and must not be
    misrepresented as being the original software.
3.  This notice may not be removed or altered from any source distribution.
  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft