Skip to content

Commit

Permalink
feat(typedoc): update CI
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreasGassmann committed Mar 23, 2021
1 parent 95112f6 commit f6caa1e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 16 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Deploy Docs

on: [workflow_dispatch]
on: push

jobs:
deploy_github_pages:
Expand Down Expand Up @@ -29,8 +29,8 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
npm run docs:build
cd docs/.vuepress/dist
npm run typedoc
cd docs
echo 'docs.walletbeacon.io' > CNAME
git config --global user.email "[email protected]"
git config --global user.name "github-actions-bot"
Expand Down
13 changes: 0 additions & 13 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,6 @@ The documentation can be found [here](https://docs.walletbeacon.io/).
npm i --save @airgap/beacon-sdk
```

## Upgrading from v1 to v2

Beacon SDK v2 introduces some some breaking changes from a developer perspective, most of the changes are internal, specifically in the communication protocol between dApps and Extensions/Wallets. All major Wallets that support Beacon (tzip-10) have been updated to support both v1 and v2 DApps.

We highly encourage developers to upgrade to v2. Besides stability improvements, the most notable new features are:

- Support for multiple browser extensions (eg. Thanos and Spire)
- Support for mobile, browser and desktop Wallets
- Mobile support via Deeplinking
- Secure and encrypted communication between DApp and Browser Extension

[Changelog](https://docs.walletbeacon.io/CHANGELOG.html)

## Example DApp integration

```ts
Expand Down

0 comments on commit f6caa1e

Please sign in to comment.