Skip to content

Commit be56940

Browse files
authored
README (#26)
* README * README * README
1 parent 3dcf52f commit be56940

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
All pure-js cryptographic primitives normally used when
66
developing Javascript / TypeScript applications and tools for Ethereum.
77

8-
**January 2022 update:** Version 1.0 of the package will be out soon. The module has been completely rewritten:
8+
**January 2022 update:** We've released v1.0 of the package, a complete rewrite:
99

10-
- **6x smaller:** ~5,000 lines of code instead of ~27,000 (with all deps); 660KB instead of 10.2MB
10+
- **6x smaller:** ~5,000 lines of code instead of ~24,000 (with all deps); 650KB instead of 10.2MB
1111
- 5 dependencies by 1 author instead of 38 by 5 authors
1212
- [Audited](#security) by an independent security firm
13-
- Check out the [Upgrading](#upgrading) section for breaking changes (there are almost none)
13+
- Check out the article about it: [A safer, smaller, and faster Ethereum cryptography stack](https://medium.com/nomic-labs-blog/a-safer-smaller-and-faster-ethereum-cryptography-stack-5eeb47f62d79)
14+
- Take a glance at the [Upgrading](#upgrading) section for breaking changes: there are almost none
1415

1516
The cryptographic primitives included are:
1617

@@ -28,10 +29,10 @@ Use NPM / Yarn in node.js / browser:
2829

2930
```bash
3031
# NPM
31-
npm install ethereum-cryptography@next
32+
npm install ethereum-cryptography
3233

3334
# Yarn
34-
yarn add ethereum-cryptography@next
35+
yarn add ethereum-cryptography
3536
```
3637

3738
See [browser usage](#browser-usage) for information on using the package with major Javascript bundlers. It is
@@ -199,7 +200,7 @@ Note: if you've been using ethereum-cryptography v0.1, it had different API. We'
199200
## BIP32 HD Keygen
200201

201202
Hierarchical deterministic (HD) wallets that conform to BIP32 standard.
202-
Also available as standalone package [micro-bip32](https://github.com/paulmillr/micro-bip32).
203+
Also available as standalone package [scure-bip32](https://github.com/paulmillr/scure-bip32).
203204

204205
This module exports a single class `HDKey`, which should be used like this:
205206

@@ -279,7 +280,7 @@ function mnemonicToSeedSync(mnemonic: string, passphrase: string = ""): Uint8Arr
279280
The `bip39` submodule provides functions to generate, validate and use seed
280281
recovery phrases according to [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).
281282

282-
Also available as standalone package [micro-bip39](https://github.com/paulmillr/micro-bip39).
283+
Also available as standalone package [scure-bip39](https://github.com/paulmillr/scure-bip39).
283284

284285
```js
285286
const { generateMnemonic } = require("ethereum-cryptography/bip39");
@@ -453,7 +454,7 @@ Version 1.0 changes from 0.1:
453454

454455
1. We return `Uint8Array` from all methods that worked with `Buffer` before.
455456
`Buffer` has never been supported in browsers, while `Uint8Array`s are supported natively in both
456-
browsers and node.js. See [Upgrading](#upgrading)
457+
browsers and node.js.
457458
2. We target runtimes with [bigint](https://caniuse.com/bigint) support,
458459
which is Chrome 67+, Edge 79+, Firefox 68+, Safari 14+, node.js 10+. If you need to support older runtimes, use `[email protected]`
459460
3. If you've used `secp256k1`, [rename it to `secp256k1-compat`](#legacy-secp256k1-compatibility-layer)

0 commit comments

Comments
 (0)