@airgap/beacon-dapp - npm Package Compare versions

Comparing version 3.1.0 to 3.1.1

dist/esm/dapp-client/DAppClient.js

@@ -12,3 +12,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 import { TransportType, StorageKey, BeaconMessageType, PermissionScope, NetworkType, Origin, BeaconErrorType, SigningType, ColorMode } from '@airgap/beacon-types';
-import { Client, BeaconError, AppMetadataManager, Serializer, LocalStorage, getAccountIdentifier, getSenderId, BEACON_VERSION, Logger } from '@airgap/beacon-core';
+import { Client, BeaconError, AppMetadataManager, Serializer, LocalStorage, getAccountIdentifier, getSenderId, Logger } from '@airgap/beacon-core';
 import { getAddressFromPublicKey, ExposedPromise, generateGUID } from '@airgap/beacon-utils';
@@ -1123,3 +1123,3 @@ import { messageEvents } from '../beacon-message-events';
                 id: messageId,
-                version: BEACON_VERSION,
+                version: '3',
                 senderId: yield getSenderId(yield this.beaconId),
@@ -1126,0 +1126,0 @@ message: requestInput

package.json

 {
   "name": "@airgap/beacon-dapp",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "> TODO: description",
@@ -38,9 +38,9 @@ "author": "Andreas Gassmann <[e-mail]>",
   "dependencies": {
-    "@airgap/beacon-core": "^3.1.0",
-    "@airgap/beacon-transport-matrix": "^3.1.0",
-    "@airgap/beacon-transport-postmessage": "^3.1.0",
-    "@airgap/beacon-ui": "^3.1.0",
+    "@airgap/beacon-core": "^3.1.1",
+    "@airgap/beacon-transport-matrix": "^3.1.1",
+    "@airgap/beacon-transport-postmessage": "^3.1.1",
+    "@airgap/beacon-ui": "^3.1.1",
     "qrcode-generator": "1.4.4"
   },
-  "gitHead": "9d3968617a4b58231b7b3d4bbab1fa1d2c992ebe"
+  "gitHead": "3d8814c88b3c5a651a77ad428492699864b5874c"
 }

README.md

 # `@airgap/beacon-dapp`
 
-> TODO: description
+This package is part of the `@airgap/beacon-sdk` project. [Read more](https://github.com/airgap-it/beacon-sdk)
 
+## Introduction
+
+Use this package on your dApp to instanciate a `DAppClient` object and communicate to wallets.
+
 ## Usage
 
 ```
-const beaconDapp = require('@airgap/beacon-dapp');
+import { DAppClient } from '@airgap/beacon-dapp'
 
-// TODO: DEMONSTRATE API
+const dAppClient = new DAppClient({ name: "Beacon Docs" });
 ```
+
+Check our documentation for more information. [Documentation](https://docs.walletbeacon.io)

No alert changes

Improved metrics

Total package byte prevSize

2042273

increased by0.01%

Number of lines in readme file

18

increased by50%

Dependency changes

• Updated@airgap/beacon-core@^3.1.1

• Updated@airgap/beacon-transport-matrix@^3.1.1

• Updated@airgap/beacon-transport-postmessage@^3.1.1

• Updated@airgap/beacon-ui@^3.1.1