@tezos-x/octez.connect-sdk 0.9.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +18 -6
  2. package/dist/octez.connect.min.js +1 -1126
  3. package/package.json +17 -15
package/README.md CHANGED
@@ -1,16 +1,28 @@
1
- # octez.connect SDK
1
+ # Octez Connect SDK
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/@tezos-x/octez.connect-sdk.svg?colorB=brightgreen)](https://www.npmjs.com/package/@tezos-x/octez.connect-sdk)
4
- [![documentation](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://trilitech.github.io/octez.connect-sdk/)
5
- [![GitHub Action](https://github.com/trilitech/octez.connect-sdk/workflows/Build%2C%20Test%20and%20Analyze/badge.svg)](https://github.com/trilitech/octez.connect-sdk/actions?query=workflow%3A%22Build%2C+Test+and+Analyze%22+branch%3Amain)
4
+ [![documentation](https://img.shields.io/badge/documentation-online-brightgreen.svg)](https://octez-connect.tezos.com)
5
+ [![GitHub Action](https://github.com/trilitech/octez.connect/workflows/Build%2C%20Test%20and%20Analyze/badge.svg)](https://github.com/trilitech/octez.connect/actions?query=workflow%3A%22Build%2C+Test+and+Analyze%22+branch%3Amain)
6
6
  [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
7
7
 
8
+ > Connect Wallets with dApps on Tezos
9
+
10
+ [Octez Connect](https://octez-connect.tezos.com) is the implementation of the wallet interaction standard [tzip-10](https://gitlab.com/tzip/tzip/blob/master/proposals/tzip-10/tzip-10.md) which describes the connection of a dApp with a wallet.
11
+
8
12
  ## Intro
9
13
 
10
14
  The `octez.connect-sdk` simplifies and abstracts the communication between dApps and wallets over different transport layers.
11
15
 
12
- Developers that plan to develop complex smart contract interactions can use [Taquito](https://github.com/ecadlabs/taquito) with the `BeaconWallet`, which uses this SDK under the hood, but provides helpful methods to interact with contracts.
16
+ Developers that plan to develop complex smart contract interactions can use [Octez.js](https://github.com/trilitech/octez.js) with the `BeaconWallet`, which uses this SDK under the hood, but provides helpful methods to interact with contracts.
17
+
18
+ Besides this Typescript SDK, we also provide SDKs for native iOS and Android Wallets:
19
+
20
+ - [Beacon Android SDK (Kotlin)](https://github.com/trilitech/octez.connect-android-sdk)
21
+ - [Beacon iOS SDK (Swift)](https://github.com/trilitech/octez.connect-ios-sdk)
22
+
23
+ ## Documentation
13
24
 
25
+ The documentation can be found [here](https://octez-connect.tezos.com/), technical documentation can be found [here](https://typedocs.octez-connect.tezos.com/).
14
26
 
15
27
  ## Installation
16
28
 
@@ -63,9 +75,9 @@ client
63
75
 
64
76
  For a more complete example, take a look at the `example-wallet.html` file.
65
77
 
66
- ## Adding a wallet to octez.connect-sdk
78
+ ## Adding a wallet to octez.connect
67
79
 
68
- Please create a PR and add your wallet [here](https://github.com/trilitech/octez.connect-sdk/blob/master/scripts/generate-wallet-list.ts).
80
+ Wallets are managed in the [beacon-wallet-list](https://github.com/airgap-it/beacon-wallet-list) repository. Please create a PR there to add your wallet.
69
81
 
70
82
  For iOS wallets, the wallet needs to define a custom url scheme to support the same-device functionality.
71
83