Skip to content

Commit 2a26ada

Browse files
committed
Doc updates
1 parent f9291d8 commit 2a26ada

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ JavaScript library to easily onboard users to ethereum apps by enabling wallet s
99
## Quick Start with Default Modules
1010

1111
```javascript
12-
import { init, modules } from "bn-onboard"
12+
import Onboard from "bn-onboard"
1313

1414
// initialize onboard
15-
const onboard = init({
15+
const onboard = Onboard.init({
1616
dappId: "Your apiKey here",
1717
networkId: 1,
1818
subscriptions: {
@@ -28,15 +28,15 @@ const onboard = init({
2828
},
2929
modules: {
3030
// default wallets that are included: MetaMask, Dapper, Coinbase, Trust, WalletConnect
31-
walletSelect: modules.select.defaults({
31+
walletSelect: Onboard.modules.select.defaults({
3232
// if you want fortmatic as a wallet option
3333
fortmaticInit: { apiKey: "Your fortmatic key here" },
3434
// if you want portis as a wallet option
3535
portisInit: { apiKey: "Your portis key here" },
3636
networkId: 4
3737
}),
3838
// default ready steps are: connect, network, balance
39-
walletReady: modules.ready.defaults({
39+
walletReady: Onboard.modules.ready.defaults({
4040
networkId: 4,
4141
minimumBalance: "200000000000000000"
4242
})
@@ -227,13 +227,13 @@ fortmatic({
227227
#### Example
228228

229229
```javascript
230-
import { init, modules } from "bnc-onboard"
230+
import Onboard from "bnc-onboard"
231231

232232
// PICK AND CHOOSE MODULES
233233

234-
const { portis, dapper, metamask, fortmatic } = modules.select
234+
const { portis, dapper, metamask, fortmatic } = Onboard.modules.select
235235

236-
const onboard = init({
236+
const onboard = Onboard.init({
237237
// ...
238238
modules: {
239239
walletSelect: {
@@ -257,10 +257,10 @@ const onboard = init({
257257

258258
// USE ALL OF THE DEFAULT MODULES
259259

260-
const onboard = init({
260+
const onboard = Onboard.init({
261261
// ...
262262
modules: {
263-
walletSelect: modules.select.defaults({
263+
walletSelect: Onboard.modules.select.defaults({
264264
portisInit: { apiKey: "Your portis key here" },
265265
networkId: 4
266266
}),
@@ -302,13 +302,13 @@ balance(String) // the minimum balance in wei required to interact with your da
302302
#### Example
303303

304304
```javascript
305-
import { init, modules } from "bnc-onboard"
305+
import Onboard from "bnc-onboard"
306306

307307
// PICK AND CHOOSE MODULES
308308

309-
const { connect, network, balance } = modules.ready
309+
const { connect, network, balance } = Onboard.modules.ready
310310

311-
const onboard = init({
311+
const onboard = Onboard.init({
312312
// ...
313313
modules: {
314314
//....
@@ -320,11 +320,11 @@ const onboard = init({
320320

321321
// USE ALL OF THE DEFAULT MODULES
322322

323-
const onboard = init({
323+
const onboard = Onboard.init({
324324
// ...
325325
modules: {
326326
// ...
327-
walletReady: modules.ready.defaults({
327+
walletReady: Onboard.modules.ready.defaults({
328328
networkId: 1,
329329
minimumBalance: "400000000000"
330330
})

0 commit comments

Comments
 (0)