Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Rewrite Documentation (v4) #277

Merged
merged 16 commits into from
May 6, 2022
Merged

docs: Rewrite Documentation (v4) #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0dccfb3
Initial attempt to document the new selector API.
lewis-sqa May 5, 2022
f55901a
More tweaks.
lewis-sqa May 5, 2022
88e1bf3
Initial attempt to document wallets.
lewis-sqa May 5, 2022
bccc2ee
Added properties.
lewis-sqa May 5, 2022
163419c
Added docs for state.
lewis-sqa May 5, 2022
d380e67
Moved docs.
lewis-sqa May 5, 2022
8b57aaa
Updated setup examples.
lewis-sqa May 5, 2022
5bab0bf
Fixed TODOs.
lewis-sqa May 5, 2022
8ec33f7
Fixed TODOs.
lewis-sqa May 5, 2022
9a8cef4
Fixed TODOs.
lewis-sqa May 5, 2022
29b7169
Added reference to docs.
lewis-sqa May 5, 2022
6ba724a
Switched to Account.
lewis-sqa May 5, 2022
2bae810
Updated root README.
lewis-sqa May 5, 2022
204c6b7
Aligned terminology.
lewis-sqa May 5, 2022
ed2c196
Aligned styling.
lewis-sqa May 5, 2022
f8bede2
Aligned links.
lewis-sqa May 5, 2022
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

The NEAR Wallet Selector makes it easy for users to interact with your dApp. This package presents a modal to switch between a number of supported wallet types:

- [NEAR Wallet](https://www.npmjs.com/package/@near-wallet-selector/near-wallet) - Web wallet.
- [Sender](https://www.npmjs.com/package/@near-wallet-selector/sender) - Browser extension wallet.
- [Math Wallet](https://www.npmjs.com/package/@near-wallet-selector/math-wallet) - Browser extension wallet.
- [NEAR Wallet](https://www.npmjs.com/package/@near-wallet-selector/near-wallet) - Browser wallet.
- [Sender](https://www.npmjs.com/package/@near-wallet-selector/sender) - Injected wallet.
- [Math Wallet](https://www.npmjs.com/package/@near-wallet-selector/math-wallet) - Injected wallet.
- [Ledger](https://www.npmjs.com/package/@near-wallet-selector/ledger) - Hardware wallet.
- [WalletConnect](https://www.npmjs.com/package/@near-wallet-selector/wallet-connect) - Bridge wallet.

Expand Down Expand Up @@ -49,17 +49,17 @@ npm install \
Then them in your dApp:

```ts
import NearWalletSelector from "@near-wallet-selector/core";
import { setupWalletSelector } from "@near-wallet-selector/core";
import { setupNearWallet } from "@near-wallet-selector/near-wallet";
import { setupSender } from "@near-wallet-selector/sender";
import { setupMathWallet } from "@near-wallet-selector/math-wallet";
import { setupLedger } from "@near-wallet-selector/ledger";
import { setupWalletConnect } from "@near-wallet-selector/wallet-connect";

const selector = await NearWalletSelector.init({
const selector = await setupWalletSelector({
network: "testnet",
contractId: "guest-book.testnet",
wallets: [
modules: [
setupNearWallet(),
setupSender(),
setupLedger(),
Expand Down
Loading