Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

postmanreadmegen

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

postmanreadmegen

PostmanReadmeGen is a versatile tool that simplifies the process of generating informative README files for your GitHub repositories. It seamlessly integrates with Postman collections and includes a convenient pre-commit script to automate this task. With

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

PostmanReadmeGen

PostmanReadmeGen is a tool that generates documentation from Postman collections into README files. It creates two sections within the README:

  1. Summary: A concise summary of the Postman collection.
  2. Detailed: This section includes detailed information from the collection.

Installation

To get started, import generateTrees and provide a folder with your Postman collections.

import { generateTrees } from 'postmanreadmegen';
generateTrees('collection');

Then simply run node yourfile.js.

Contributing

Contributions are welcome. Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License, which you can read in the LICENSE file.

Author

  • Author: Siarhei Zavadski

Keywords

FAQs

Package last updated on 02 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc