Skip to content

Commit eddd9c3

Browse files
committed
Improve README.md
1 parent a994095 commit eddd9c3

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
[![license][5]][6]
66
[![Types][7]][8]
77

8-
⚠️ **WARNING: This project is under active development. Don't use it until a stable version is released.** ⚠️
9-
108
This npm package contains all the cryptographic primitives normally used when
119
developing Javascript/TypeScript applications and tools for Ethereum.
1210

@@ -504,10 +502,30 @@ console.log(generateMnemonic(wordlist));
504502
This package works with all the major Javascript bundlers. It is
505503
tested with `webpack`, `Rollup`, `Parcel`, and `Browserify`.
506504
507-
For using it with `Rollup` you need to use these plugins:
508-
* [`rollup-plugin-node-builtins`](https://www.npmjs.com/package/rollup-plugin-node-builtins) with the `browser` option set to `true`, and `preferBuiltins` to `false`.
509-
* [`rollup-plugin-node-globals`](https://www.npmjs.com/package/rollup-plugin-node-globals)
510-
* [`rollup-plugin-json`](https://www.npmjs.com/package/rollup-plugin-json).
505+
### Rollup setup
506+
507+
Using this library with Rollup requires the following plugins:
508+
509+
[`@rollup/plugin-commonjs`](https://www.npmjs.com/package/@rollup/plugin-commonjs)
510+
[`@rollup/plugin-json`](https://www.npmjs.com/package/@rollup/plugin-json)
511+
[`@rollup/plugin-node-resolve`](https://www.npmjs.com/package/@rollup/plugin-node-resolve)
512+
[`rollup-plugin-node-builtins`](https://www.npmjs.com/package/rollup-plugin-node-builtins)
513+
[`rollup-plugin-node-globals`](https://www.npmjs.com/package/rollup-plugin-node-globals)
514+
515+
These can be used by setting your plugins like this:
516+
517+
```js
518+
plugins: [
519+
commonjs(),
520+
json(),
521+
nodeGlobals(),
522+
nodeBuiltins(),
523+
resolve({
524+
browser: true,
525+
preferBuiltins: false,
526+
}),
527+
]
528+
```
511529
512530
## Missing cryptographic primitives
513531

0 commit comments

Comments
 (0)