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

V1.0.0 beta #17

Merged
merged 11 commits into from
Jan 30, 2019
Prev Previous commit
Next Next commit
Update README.md
pedrouid authored Jan 30, 2019
commit 21a75be5b16c88945ddb977ecadee322679292e4
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# WalletConnect v0.7.x
# WalletConnect v1.0.0-beta

## Introduction

Wallet Connect is a simple solution that enables communication between desktop Dapps and mobile Wallets using a QR Code to establish a session. It's an open protocol and does not require the User to have specific hardware or install any software. The protocol is agnostic to any mobile Wallets that wishes to support it and enables Dapp developers to integrate with several mobile Wallets through a single implementation.
WalletConnect is an open protocol to communicate securely between Wallets and Dapps (Web3 Apps). The protocol establishes a remote connection between two apps and/or devices using a Bridge server to relay payloads. These payloads are symmetrically encrypted through a shared key between the two peers. The connection is initiated by one peer displaying a QR Code or deep link with a standard WalletConnect URI and is established when the counter-party approves this connection request. It also includes an optional Push server to allow Native applications to notify the user of incoming payloads for establishes connections.

## Getting Started

Currently the WalletConnect protocol has implementations in Javascript for Browser SDK, Wallet SDK, Push Notification Webhook and in Python for the Bridge Server.
Currently the WalletConnect protocol has references implementations written in Typescript for the Client SDK (browser/react-native), the Bridge Server and the Push server.

To quickly setup for your Dapp or Wallet, go to [Quick Start](quick-start.md)
To quickly setup for your Dapp or Wallet, go to [Quick Start](quick-start.md) for code examples.

To read the technical specification of the WalletConnect protocol, go to [Technical Specification](tech-spec.md)
To read in more detail about the WalletConnect protocol, go to [Technical Specification](tech-spec.md)

To reference all the Bridge API calls go to [Bridge API](bridge-api.md)
Additionally you can also consult the API references for [Client SDK](bridge-sdk.md), [Bridge Server](bridge-server.md) and [Push Server](push-server.md)

## Community

Share your experience, contribute or ask questions with the WalletConnect Community

* Github: [https://github.com/walletconnect](https://github.com/walletconnect)
* Telegram: [https://t.me/walletconnect](https://t.me/walletconnect)
* Forum: [https://discuss.walletconnect.org](https://discuss.walletconnect.org)
* Discord: [https://discord.walletconnect.org](https://discord.walletconnect.org)

- Github: [https://github.walletconnect.org](https://github.walletconnect.org)
- Forum: [https://discuss.walletconnect.org](https://discuss.walletconnect.org)
- Discord: [https://discord.walletconnect.org](https://discord.walletconnect.org)
- Telegram: [https://telegram.walletconnect.org](https://telegram.walletconnect.org)
- Twitter: [https://twitter.walletconnect.org](https://twitter.walletconnect.org)