From ac31b5d7f3cefc3e024ef145ed259d8c0a48d229 Mon Sep 17 00:00:00 2001 From: Liran Tal Date: Tue, 7 Apr 2020 11:51:28 +0300 Subject: [PATCH] fix: update docs --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f49a38d..4a419fb 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,21 @@ npm install --save js-vulns-detector # Usage -```js -// @TODO -const {} = require('js-vulns-detector') +## One-off invocation + +To generate a bundle file: + +```sh +npx js-vulns-detector --global --outfile bundle.js ``` -# Example +## As a library - +Access the bundle directly as an npm module: + +```js +import 'js-vulns-detector/dist/bundle-global.js' +``` # Contributing