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
npm install postmanreadmegenPostmanReadmeGen 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.
To get started, import generateTrees and provide a folder with your Postman collections.
``javascript`
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