Skip to content

Commit

Permalink
updating the readme with steps to build locally
Browse files Browse the repository at this point in the history
  • Loading branch information
Karthik Subramanian authored and Karthik Subramanian committed May 21, 2020
1 parent 39a660e commit 1f19156
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ Generate HTML API documentation from a postman collection.
3. js - this is the javascript folder consisting of the required js files
## To build locally
- Clone the repository
- pip install the dependencies from the requirements file
```
pip install -r requirements.txt
```
- run the code
```
python postman_doc_gen.py [path/to/collection] -o [path/to/output/folder]
```
## Sample HTML Documentation
A video of the sample html document generated using the collection and environment json files
Expand Down

0 comments on commit 1f19156

Please sign in to comment.