Skip to content

Commit

Permalink
fix readme (#497)
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenmarcus authored Mar 21, 2024
1 parent 3cd0858 commit 93f07aa
Showing 1 changed file with 38 additions and 34 deletions.
72 changes: 38 additions & 34 deletions packages/wallet/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,45 @@
[//]: # `{ "title": "@mintbase-js/wallet", "order": "1" }`



# @mintbase-js/wallet



![](https://github.com/Mintbase/mintbase-js/assets/11164548/39d50d30-f2e2-45fc-ba69-1853c6906ef1)




This is the [Mintbase Wallet](https://wallet.mintbase.xyz/) SDK package.
You can check a quick example of Simple Login using Next.js 14 and @mintbase-js/react


check our [React integration](https://docs.mintbase.xyz/dev/mintbase-sdk-ref/react#mintbasewalletcontextprovider)

Example:
You can check a [quick example of Simple Login](https://github.com/Mintbase/examples/tree/main/starter) using Next.js 14 and @mintbase-js/react


<p align="center">
<img src='https://img.shields.io/npm/dw/@mintbase-js/wallet' />
<img src='https://img.shields.io/bundlephobia/min/@mintbase-js/wallet'>
</p>



## Video tutorial

https://github.com/Mintbase/mintbase-js/assets/8454267/7301c178-3a34-497c-a2e7-1616d8f8b6a2


check our [React integration](https://docs.mintbase.xyz/dev/mintbase-sdk-ref/react#mintbasewalletcontextprovider)

Example:
You can check a [quick example of Simple Login](https://github.com/Mintbase/examples/tree/main/starter) using Next.js 14 and @mintbase-js/react


## Installation and Usage



The easiest way to use this package is to install it from the NPM registry, this package requires `near-api-js` v1.0.0 or above:



```bash

Expand All @@ -48,52 +52,52 @@ yarn add near-api-js

npm install near-api-js



# Using PNPM.


pnpm install near-api-js



```



```bash

# Using Yarn

yarn add @mintbase-js/wallet



# Using NPM.

npm install @mintbase-js/wallet



# Using PNPM.

pnpm install @mintbase-js/wallet



```



Then use it in your dApp:




{% code title="setup.ts" overflow="wrap" lineNumbers="true" %}




```ts
import { setupWalletSelector } from "@near-wallet-selector/core";
Expand All @@ -114,19 +118,19 @@ const selector = await setupWalletSelector({

{% endcode %}




## setupMintbaseWallet



`networkId:` Near Networks
`walletUrl:` valid wallet urls
`successUrl:` If you dont have a single callback entrypoint to handle failure/success you can set successUrl.
`failureUrl:` If you dont have a single callback entrypoint to handle failure/success you can set failureUrl.
`callbackUrl:` when you have a single entrypoint to deal with transaction results.
`contractId`: the ContractId that your dapp will be using aka (receiverId)

- `networkId:` Near Networks
- `walletUrl:` valid wallet urls
- `successUrl:` If you dont have a single callback entrypoint to handle failure/success you can set successUrl.
- `failureUrl:` If you dont have a single callback entrypoint to handle failure/success you can set failureUrl.
- `callbackUrl:` when you have a single entrypoint to deal with transaction results.
- `contractId`: the ContractId that your dapp will be using aka (receiverId)

## Troubleshooting

Expand All @@ -137,4 +141,4 @@ Any other questions or issues you can contact support on our [Telegram Channel](

## License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

0 comments on commit 93f07aa

Please sign in to comment.