Skip to content

Commit

Permalink
update package name and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelgoeke committed May 1, 2024
1 parent d5b0c0b commit e7c820c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
push:
branches:
- 'main'
- 'npm_package'

jobs:
publish-npm:
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# k6-script-from-har

`k6-script-from-har` is a powerful tool designed to simplify the process of performance testig. The primary objective of this project is to generate k6 test scirpts from HTTP Archive (`.har`) files. These `.har` files contain information about HTTP requests and responses, which can be used to simulate network traffic and test the performance of your web application.
Dead simple k6 test generator.
Given a har file, this script scrapes and generates idiomatic k6 test code.

Create a .har file by opening a browser's network tab, navigate, click `export HAR` button. Or can be combined with tools like `Playwright` to have automated tests generate the .har file.

Includes `testTemplate.js` and `testCommon.js` as a starting factoring of shared structure. May be modified after install to your liking. Includes example for getting Auth bearer tokens and attaching them to requests.

# Installation
``` sh
npm install --save k6-script-from-har
npm install --save-dev k6-script-from-har
```

# Usage
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "@dnvgl/k6scriptfromhar",
"name": "k6-script-from-har",
"version": "1.0.0",
"description": "helper utility to generate k6 test script given a .har file",
"description": "k6 script from har - dead simple k6 test generator",
"bin": {
"k6scriptfromhar": "bin/k6scriptfromhar.js"
"k6-script-from-har": "bin/k6scriptfromhar.js"
},
"files": [
"bin/**/*.*",
Expand Down

0 comments on commit e7c820c

Please sign in to comment.