Skip to content
This repository has been archived by the owner on Nov 23, 2021. It is now read-only.

Commit

Permalink
readme: Prepare for npm publication
Browse files Browse the repository at this point in the history
  • Loading branch information
robingustafsson committed Mar 26, 2019
1 parent 6993f6a commit 1e4abfd
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand All @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit 1e4abfd

Please sign in to comment.