diff --git a/README.md b/README.md index 9628ee7..4a0f194 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

- Client library that wraps common patterns when interact with the VirusTotal Augment product. + Client library that wraps common patterns when interacting with the VirusTotal Augment product.

@@ -15,20 +15,21 @@ # Table of Contents * [Installation](#installation) -* [Compatibility](#compatibility) * [Usage](#usage) -* [Api](#api) -* [License](#license) +* [API](#api) + +# Installation +```bash +npm i @virustotal/vt-augment --save +``` # Usage **VT Augment is bundled using the UMD format (@`dist/vt-augment.min.js`).** -Download the last version found in the `dist` folder and add to your static files. - ```html - + ``` ## Code @@ -61,7 +62,7 @@ Creates a new object with a html element and a set of options. An iframe is dyna *Methods can be chained and can be called in whatever order.* | [load](#loadurl-string) | [preload](#preloadurl-string) | [openDrawer](#opendrawer) | [closeDrawer](#closedrawer) | [loading](#loading(active-boolean)) -|-----|-----|-----|-----|-----|-----| +|-----|-----|-----|-----|-----| #### load(url: string) diff --git a/package.json b/package.json index 074372b..5781e8e 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "@virustotal/vt-augment", "version": "1.5.3", "description": "Client library that wraps common patterns when interact with the VirusTotal Augment product", + "main": "dist/vt-augment.min.js", "keywords": [ "virustotal", "malware", @@ -19,8 +20,8 @@ "build": "gulp && npm run size", "size": "ls -hl dist/ | awk 'FNR == 2 {print $5}'" }, - "author": "", - "license": "", + "author": "VirusTotal team", + "license": "MIT", "devDependencies": { "google-closure-compiler": "^20210302.0.0", "google-closure-library": "^20210302.0.0",