diff --git a/README.md b/README.md index 8fbdff1..cdcbcd3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o un ``` #### Windows -**For windows download the binary and set environment variable so that you can access the binary from terminal** +**For windows download the binary to set environment variable so that you can access the binary from terminal** #### Binary link [Download binary](https://github.com/thedevsaddam/docgen/releases) @@ -38,6 +38,12 @@ curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o un * To make HTML documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.html` * To make Markdown documentation use `docgen build -i input-postman-collection.json -o ~/Downloads/index.md -m` +### Usage for Windows +* After you have downloaded the binary, `windows_amd64.exe`, copy it and paste it in the same folder as your `input-postman-collection.json`. +* Open terminal in that folder and use `windows_64 build -i input-postman-collection.json -o ./index.html` +* Notice that in previous command we used `windows_64 build -i`. If we rename the binary that we downloaded to `docgen`, we can use the previous commands in above `Usage` section. +* After changing the binary name, the build command now is `docgen build -i input-postman-collection.json -o ./index.html` + ***[Demo markdown API documentation](_examples/example-doc.md)*** ### Contributor