Skip to content

Commit

Permalink
improve: readme document
Browse files Browse the repository at this point in the history
  • Loading branch information
mlikhtar authored and thekiba committed Jul 10, 2024
1 parent f1a3583 commit cfe1f9b
Showing 1 changed file with 50 additions and 34 deletions.
84 changes: 50 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,65 @@
# TON Connect
# 🚀 TON Connect

This is the implementation of the TonConnect protocol. You can find more details about TonConnect protocol in the [docs](https://docs.ton.org/develop/dapps/ton-connect/overview).
Welcome to the implementation of the TonConnect protocol! Before diving in, here's where to start:

[Latest API documentation](https://ton-connect.github.io/sdk/)

Repository contains following packages:
- [@tonconnect/sdk](https://www.npmjs.com/package/@tonconnect/sdk)
- [@tonconnect/protocol](https://www.npmjs.com/package/@tonconnect/protocol)
- [@tonconnect/ui](https://www.npmjs.com/package/@tonconnect/ui)
- [@tonconnect/ui-react](https://www.npmjs.com/package/@tonconnect/ui-react)
- Easily connect users to your Dapp and start blockchain interactions:
- [TON Connect UI React](https://www.npmjs.com/package/@tonconnect/ui-react): Seamlessly integrate wallet connection components into your React app.
- [TON Connect UI](https://www.npmjs.com/package/@tonconnect/ui): Quickly add wallet connection components to your Dapp.

## TON Connect SDK
- [github link](https://github.com/ton-connect/sdk/tree/main/packages/sdk)
- [npm link](https://www.npmjs.com/package/@tonconnect/sdk)
- [API documentation](https://ton-connect.github.io/sdk/modules/_tonconnect_sdk.html)

Use it to connect your app to TON wallets via TonConnect protocol.
You can find the full description in the link above.
- For detailed information about the TonConnect protocol, visit the [official documentation](https://docs.ton.org/develop/dapps/ton-connect/overview).

## TON Connect protocol models
- [github link](https://github.com/ton-connect/sdk/tree/main/packages/protocol)
- [npm link](https://www.npmjs.com/package/@tonconnect/protocol)
- [API documentation](https://ton-connect.github.io/sdk/modules/_tonconnect_protocol.html)
- [📚 Latest API documentation](https://ton-connect.github.io/sdk/)

This package contains protocol requests, responses and event models and encoding, decoding functions.
You can use it to integrate TonConnect to your wallet app (written with TypeScript).
If you want to integrate TonConnect to your dApp, you should use [@tonconnect/sdk](https://www.npmjs.com/package/@tonconnect/sdk).
## 📦 Packages

## TON Connect UI
- [github link](https://github.com/ton-connect/sdk/tree/main/packages/ui)
- [npm link](https://www.npmjs.com/package/@tonconnect/ui)
- [API documentation](https://ton-connect.github.io/sdk/modules/_tonconnect_ui.html)
The repository contains the following packages:

- [**@tonconnect/sdk**](https://www.npmjs.com/package/@tonconnect/sdk)
- [**@tonconnect/protocol**](https://www.npmjs.com/package/@tonconnect/protocol)
- [**@tonconnect/ui**](https://www.npmjs.com/package/@tonconnect/ui)
- [**@tonconnect/ui-react**](https://www.npmjs.com/package/@tonconnect/ui-react)

TonConnect UI is a UI kit for TonConnect SDK. Use it to connect your app to TON wallets via TonConnect protocol.
It allows you to integrate TonConnect to your app easier using our UI elements such as "connect wallet button", "select wallet dialog" and confirmation modals.
---

## TON Connect UI React
- [github link](https://github.com/ton-connect/sdk/tree/main/packages/ui-react)
- [npm link](https://www.npmjs.com/package/@tonconnect/ui-react)
- [API documentation](https://ton-connect.github.io/sdk/modules/_tonconnect_ui_react.html)
## 📘 TON Connect SDK
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/sdk)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/sdk)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_sdk.html)

Use this package to connect your app to TON wallets via the TonConnect protocol.
A full description can be found in the link above.

TonConnect UI React is a React UI kit for TonConnect SDK. Use it to connect your app to TON wallets via TonConnect protocol in React apps.
---

## Development
## 📗 TON Connect Protocol Models
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/protocol)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/protocol)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_protocol.html)

Follow the instructions in [DEVELOPERS.md](./DEVELOPERS.md) to setup the development environment.
This package contains protocol requests, responses, and event models, along with encoding and decoding functions. Use it to integrate TonConnect into your wallet app (written with TypeScript). For integrating TonConnect into your dApp, use [@tonconnect/sdk](https://www.npmjs.com/package/@tonconnect/sdk).

---

## 📙 TON Connect UI
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/ui)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/ui)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_ui.html)

TonConnect UI is a UI kit for TonConnect SDK. Use it to connect your app to TON wallets via the TonConnect protocol. It simplifies integration using UI elements like the "connect wallet button," "select wallet dialog," and confirmation modals.

---

## 📕 TON Connect UI React
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/ui-react)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/ui-react)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_ui_react.html)

TonConnect UI React is a React UI kit for TonConnect SDK. Use it to connect your app to TON wallets via the TonConnect protocol in React apps.

---

## 🛠️ Development

Follow the instructions in [DEVELOPERS.md](./DEVELOPERS.md) to set up the development environment.

0 comments on commit cfe1f9b

Please sign in to comment.