From d85924581f0a1d76b26d33d7997cb068f5676209 Mon Sep 17 00:00:00 2001 From: christian-bromann Date: Tue, 5 May 2020 14:53:22 +0200 Subject: [PATCH] update readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc24528..5a10f4f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ -Node.js saucectl Wrapper +Node.js saucectl Wrapper ![build](https://github.com/saucelabs/node-saucectl/workflows/saucectl%20pipeline/badge.svg) ======================== Node.js wrapper for saucectl: Sauce Labs Testrunner Toolkit. + +## Install + +To install `saucectl` using NPM just run: + +```sh +$ npm i -g saucectl +``` + +The command should be globally available: + +```sh +$ saucectl -v +saucectl version 0.4.0 +(build 7468a24c788b4ca4d67d50372c839edf03e5df6a) +``` + +__Note:__ if you run the command for the first time it will initially download the binary for you. This only happens once. + +For more information to `saucectl`, visit its main repository: [saucelabs/saucectl](https://github.com/saucelabs/saucectl).