Skip to content
This repository was archived by the owner on Feb 25, 2019. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,25 @@ encourage or provide a [native, if not core][wtf] Web Cryptography module.
$ npm install @trust/webcrypto --save
```

### Not for use in Webpack

This library is not for use in Webpack.

The whole point of this library is that it's an exact duplicate of the browser's WebCrypto API,
for the server side.

For Webpacked web applications,
you don't need it (and can't use it).
If this module is transitively included by another dependency,
you have to exclude it by adding it to the [`externals` section in the Webpack config](https://webpack.js.org/configuration/externals/),
such as this:

```
externals: {
'@trust/webcrypto': 'crypto'
}
```

## Usage

```javascript
Expand Down Expand Up @@ -109,7 +128,7 @@ Only the following paramaters are supported for the corresponding algorithm.
| Algorithm name | Supported paramater |
| -------------- | ------------------- |
| ECDSA | `K-256 (secp256k1)`, `P-256`, `P-384`, `P-512` |
| EDDSA | `ed25519` |
| EDDSA | `ed25519` |
| AES-CTR | `sha-1` |


Expand Down