Skip to content

Commit

Permalink
Merge pull request #12 from VirusTotal/feature/some-fixes
Browse files Browse the repository at this point in the history
Some doc fixes and typos
  • Loading branch information
azakrzewski authored May 11, 2021
2 parents 41b0b7e + 08f8574 commit f63a299
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</h1>

<h4 align="center">
Client library that wraps common patterns when interact with the <a href="https://developers.virustotal.com/v3.0/reference?#widget-overview">VirusTotal Augment product<a>.
Client library that wraps common patterns when interacting with the <a href="https://developers.virustotal.com/v3.0/reference?#widget-overview">VirusTotal Augment product<a>.
</h4>

<h4 align="center">
Expand All @@ -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
<!--- "VTAugment" will be attached to the global window object. -->
<script src="vt-augment.min.js"></script>
<script src="./node_modules/@virustotal/vt-augment/dist/vt-augment.min.js"></script>
```

## Code
Expand Down Expand Up @@ -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)

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit f63a299

Please sign in to comment.