Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
snanovskyi committed Oct 9, 2019
1 parent 71a2c93 commit b478ece
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,24 @@ You can install this module from npm. Another option is to add it via `script` t
### npm
You will need to install `@virgilsecurity/keyknox`.
```sh
npm install @virgilsecurity/keyknox
npm install @virgilsecurity/keyknox@0.3.1
```

You will also need to install `virgil-crypto` and `virgil-sdk` from npm.
```sh
npm install virgil-crypto@next virgil-sdk@next
npm install virgil-crypto@4.0.0-alpha.13 virgil-sdk@6.0.0-alpha.4
```
> Note that supported version of `virgil-crypto` is `4.0.0-alpha.13` and minimum supported version of `virgil-sdk` is `6.0.0-alpha.3`.

### In browser via `script` tag
You will need to add `@virgilsecurity/keyknox` script.
```html
<script src="https://unpkg.com/@virgilsecurity/keyknox/dist/keyknox.umd.js"></script>
<script src="https://unpkg.com/@virgilsecurity/keyknox@0.3.1/dist/keyknox.umd.js"></script>
```

You will also need to add `virgil-crypto` and `virgil-sdk` scripts.
```html
<script src="https://unpkg.com/virgil-crypto@next/dist/browser.umd.js"></script>
<script src="https://unpkg.com/virgil-sdk@next/dist/virgil-sdk.browser.umd.js"></script>
<script src="https://unpkg.com/virgil-crypto@4.0.0-alpha.13/dist/browser.umd.js"></script>
<script src="https://unpkg.com/virgil-sdk@6.0.0-alpha.4/dist/virgil-sdk.browser.umd.js"></script>
```

Now you can use global variables `Keyknox`, `Virgil` and `VirgilCrypto` as namespace objects, containing all of `@virgilsecurity/keyknox`, `virgil-sdk` and `virgil-crypto` exports as properties.
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"base-64": "^0.1.0"
},
"peerDependencies": {
"virgil-sdk": "^6.0.0-alpha.3"
"virgil-sdk": "6.0.0-alpha.4"
},
"devDependencies": {
"@types/chai": "^4.1.7",
Expand All @@ -49,7 +49,7 @@
"ts-node": "^8.3.0",
"typescript": "^3.5.1",
"uuid": "^3.3.2",
"virgil-crypto": "4.0.0-alpha.3",
"virgil-sdk": "^6.0.0-alpha.3"
"virgil-crypto": "4.0.0-alpha.13",
"virgil-sdk": "6.0.0-alpha.4"
}
}

0 comments on commit b478ece

Please sign in to comment.