Get ready to publish main lib version 1.0.0

Author: iskitsas

README.md

@@ -1,6 +1,6 @@
 flexbench
 ======================
-[![Build Status](https://travis-ci.org/iskitsas/http-traffic-simulator.svg?branch=developer)](https://travis-ci.org/iskitsas/http-traffic-simulator)
+[![Build Status](https://travis-ci.org/flexivian/flexbench.svg?branch=develop)](https://travis-ci.org/flexivian/flexbench)
 
 A nodejs http traffic simulator that scales.
 
@@ -10,13 +10,16 @@ Forked from http-traffic-simulator
 ==================================
 Forked repo: https://github.com/iskitsas/http-traffic-simulator
 
-Installation
-============
+Prerequisites
+=============
+- install node.js/npm 
 
-    $ npm install flexbench
 
 Quick start
 ===========
+
+- Create a `flex-test.js` file with the following content:
+```
     var trafficSimulator = require('flexbench');
     function run(){
         trafficSimulator.testDuration(5);//-1 for infinite run
@@ -52,7 +55,38 @@ Quick start
     }
 
     run();
-
+```
+- Install flexbench dependency:
+```
+npm install flexbench
+```
+
+- Run `flex-test.js`:
+```
+node flex-test.js
+```
+
+# How to run examples after cloning the project locally
+
+Inside the folder `example` you can find various examples. You can copy-paste and use them like in the Quick start guide, or you can clone the whole project locally and link/install flexbench locally (using latest source code), without installing it from public npm repository.
+
+After cloning the project from github, navigate to project and run:
+
+```
+npm link flexbench 
+```
+
+Then navigate to `example` folder and run any example you want:
+eg.
+```
+cd example
+node count-simple-request.js
+```
+
+If you want to uninstall just unlink it like this:
+```
+npm unlink flexbench
+```
 
 Features
 ========

desktop-app/package-lock.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/flexivian/flexbench/issues"
   },
-  "homepage": "https://github.com/flexivian/flexbench/blob/develop/desktop-app/README.md",
+  "homepage": "./",
   "dependencies": {
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.3.0",
@@ -38,7 +38,6 @@
     "electron": "wait-on tcp:3000 && electron .",
     "build:installer": "electron-builder -c.extraMetadata.main=build/main.js"
   },
-  "homepage": "./",
   "build": {
     "productName": "Flexbench",
     "appId": "com.flexivian.flexbench",
@@ -97,4 +96,4 @@
     "wait-on": "^6.0.1",
     "webpack-cli": "^4.10.0"
   }
-}
+}