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

Update README.md #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

Update README.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ton Connect Documentation
# TON Connect Documentation

## Developing a TON app? Use the SDK.

Expand All @@ -12,7 +12,7 @@ If you use another language, please take the JS SDK as a reference and implement

## Protocol specifications

If you implement an SDK, a wallet or want to learn more how Ton Connect works, please read below.
If you implement an SDK, a wallet or want to learn more about how TON Connect works, please read below.

* [Protocol workflow](workflows.md): an overview of all the protocols.
* [Bridge API](bridge.md) specifies how the data is transmitted between the app and the wallet.
Expand All @@ -22,7 +22,7 @@ If you implement an SDK, a wallet or want to learn more how Ton Connect works, p

## Q&A

#### I am building an HTML/JS app, what should I read?
#### I am building an HTML/JS app. What should I read?

Simply use the JS SDK and do not worry about the underlying protocols.

Expand All @@ -38,22 +38,22 @@ JS SDK does that for you; just get wallets list `connector.getWallets()` and che

Like with embedded apps (see above), JS SDK detects it for you via `injected` property of the corresponding `connector.getWallets()` list item. If you build your own SDK you should check that `window.[targetWalletJsBridgeKey].tonconnect` exists.

#### How to implement backend authorization with tonconnect?
#### How to implement backend authorization with TON Connect?

[See an example of dapp-backend](https://github.com/ton-connect/demo-dapp-backend)

#### How do I make my own bridge?

You don’t need to, unless you are building a wallet.
You don’t need to unless you are building a wallet.

If you build a wallet, you will need to provide a bridge. See our [reference implementation in Go](https://github.com/ton-connect/bridge).

Keep in mind that the wallet’s side of the bridge API is not mandated.

For a quick start you can use the common TON Connect bridge https://bridge.tonapi.io/bridge.
For a quick start, you can use the common TON Connect bridge https://bridge.tonapi.io/bridge.

#### I make a wallet, how do I add it to the list of wallets?

Submit a pull request for the [wallets-list](https://github.com/ton-blockchain/wallets-list) repository and fill our all the necessary metadata.
Submit a pull request for the [wallets-list](https://github.com/ton-blockchain/wallets-list) repository and fill out all the necessary metadata.

Apps may also add wallets directly through the SDK.