postmanreadmegen

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.

Key Features

• Simplifies the documentation of Postman collections for your GitHub projects.
• Automatically generates a README with both a summary and detailed sections.

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