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.

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

Small fixes to BTC Connect docs #4

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion developers/btc-connect/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: First Account Abstraction Protocol on Bitcoin
description: The First Account Abstraction Protocol on Bitcoin
---

# 🚀 ₿ BTC Connect
Expand Down
12 changes: 6 additions & 6 deletions developers/btc-connect/sdks/web.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
description: First Account Abstraction Protocol on Bitcoin
description: The First Account Abstraction Protocol on Bitcoin
---

# Web

## Installation

Get up and running with BTC Connect.
Get up-and-running with BTC Connect.

```bash

Expand All @@ -22,7 +22,7 @@ Note: BTC Connect is a [React](https://reactjs.org/) library.

## Configure

Register your app on the [Dashboard](https://dashboard.particle.network/) and get the `projectId`, `clientKey`, `appId.` Then replace `xxxx` below with your project configuration.
Register your app on the [Dashboard](https://dashboard.particle.network/) and get the `projectId`, `clientKey`, `appId.` Then replace `xxxx` below with your project's configuration.

Create a `ConnectProvider` react component, add `connectors` and project options.

Expand Down Expand Up @@ -78,7 +78,7 @@ const App = () => {

## Usage

BTC Connect is implemented based on React, You can use custom hooks to connect to the wallet and send transactions.
BTC Connect is implemented based on React, you can use custom hooks to connect to the wallet and send transactions.

### Connect Wallet

Expand Down Expand Up @@ -133,7 +133,7 @@ const { evmAccount } = useETHProvider(); // evm smart accounts.

### BTC Provider

After connect wallet, you can use these hook functions interact with blockchain.
After a wallet has been connected, you can use these hook functions to interact with the blockchain.

<pre class="language-typescript"><code class="lang-typescript"><strong>import { useBTCProvider } from '@particle-network/btc-connectkit';
</strong>
Expand Down Expand Up @@ -161,7 +161,7 @@ provider.sendInscription(...)

### EVM Provider

EVM Smart Account auto generate when connect wallet, you can use BTC wallet signature to send EVM transaction.
An EVM Smart Account is automatically generated when a wallet is connected, you can use the native BTC wallet signature to send EVM transaction.

```typescript
import { useBTCProvider } from '@particle-network/btc-connectkit';
Expand Down