PostmanReadmeGen is a tool that generates documentation from Postman collections into README files. It creates two sections within the README:
- Summary: A concise summary of the Postman collection.
- Detailed: This section includes detailed information from the collection.
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.
Contributions are welcome. Feel free to open an issue or submit a pull request.
This project is licensed under the MIT License, which you can read in the LICENSE file.
- Author: Siarhei Zavadski