Skip to content

Commit

Permalink
feat(docs): add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreasGassmann committed May 18, 2020
1 parent 3ca2e5d commit 88ee065
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 16 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://docs.walletbeacon.io/CHANGELOG.html
13 changes: 0 additions & 13 deletions Flows.md

This file was deleted.

87 changes: 87 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Changelog

## 0.5.0 (2020-05-15)

#### Internals

- **typescript:** update to 3.9.2
- **typescript:** enable strict mode

#### Bug Fixes

- **account-identifier:** pass Buffer to bs58check encode method

## 0.4.4 (2020-05-14)

#### Breaking Changes

- **p2p-communication-client:** make methods async

## 0.4.3 (2020-05-13)

#### Features

- **alert:** link to correct network

## 0.4.2 (2020-05-13)

#### Features

- **alert:** improve styling and wording

## 0.4.1 (2020-05-12)

#### Bug Fixes

- **alert:** inline beacon logo

## 0.4.0 (2020-05-12)

#### Internals

- **matrix:** replace `matrix-js-sdk` with internal implementation

## 0.3.0 (2020-05-08)

#### Breaking Changes

- **events:** pass overrides in constructor

#### Features

- **alert:** improve styling and wording
- **events:** send success events when receiving a beacon response

#### Bug Fixes

- **get-address-from-pubkey:** handle edpk public keys

## 0.2.0 (2020-04-30)

#### Breaking Changes

- **beacon:** remove read_address permission
- **account-identifier:** remove account identifier from beacon message

#### Features

- **beaconId:** generate keypair and use public key as `beaconId`
- **errors:** add human readable messages

#### Bug Fixes

- **transport:** fix detection of chrome extension

## 0.1.1 (2020-04-29)

#### Internals

- **exposed-promise:** use class instead of function to preserve internal state

#### Bug Fixes

- **active-account:** read active account as early as possible

## 0.1.0 (2020-04-29)

Initial stable beta release
10 changes: 7 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@

The `beacon-sdk` simplifies and abstracts the communication between dApps and wallets over different transport layers.

## Documentation

The documentation can be found [here](https://docs.walletbeacon.io/)

### Example

```ts
const client = new DAppClient({ name: 'My Sample DApp'})
const client = new DAppClient({ name: 'My Sample DApp' })

client
.requestPermissions()
.then(permissions => {
.then((permissions) => {
console.log('got permissions', permissions)
})
.catch(error => console.log(error))
.catch((error) => console.log(error))
```

### Requirements
Expand Down

0 comments on commit 88ee065

Please sign in to comment.