diff --git a/README.md b/README.md index 155b1029..7b8ecaee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# postman-to-k6 +# postman-to-k6 ![CircleCI branch](https://img.shields.io/circleci/project/github/loadimpact/postman-to-k6/master.svg) Convert a [Postman collection](https://www.getpostman.com/docs/collections) to [k6 script](https://docs.k6.io/docs). @@ -18,12 +18,24 @@ Supported Features: ## Usage -Install with npm to get the `postman-to-k6` command. +**Install**: +![npm](https://img.shields.io/npm/v/postman-to-k6.svg) ![npm](https://img.shields.io/npm/dw/postman-to-k6.svg) + +Globally, and preferably using [nvm](/~https://github.com/creationix/nvm) (at least on Unix/Linux systems to avoid filesystem permission issues when using sudo): ```shell npm install -g postman-to-k6 ``` +Locally, into `./node_modules`: +```shell +npm install postman-to-k6 +``` + +Note that this will require you to run the converter with `node node_modules/postman-to-k6/bin/postman-to-k6.js ...`. + +**Convert**: + Pass a collection export to convert. ```shell @@ -76,6 +88,11 @@ A collection of Postman examples are located under `example`. have to generate new ones. - File format v1. +## Other similar tools + +- [jmeter-to-k6](/~https://github.com/loadimpact/jmeter-to-k6/): Convert + JMeter JMX files to k6 JS. + ## Credits Thanks to [bookmoons](/~https://github.com/bookmoons) for creating this tool. Also, thanks to [borjacampina](/~https://github.com/borjacampina) for creating the original incarnation of the tool.