diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..cc07bc493 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +https://docs.walletbeacon.io/CHANGELOG.html diff --git a/Flows.md b/Flows.md deleted file mode 100644 index 84668b919..000000000 --- a/Flows.md +++ /dev/null @@ -1,13 +0,0 @@ -```mermaid -graph LR - A[dApp] --> B[P2P] - A[dApp] --> C[Extension] - C --> D{Proxy} - C --> E{Signers} - D --> F[P2P] - E --> G[Ledger] - D --> H[Deeplink] - E --> I[Local Mnemonic] -``` - -The different flows are defined in the flows folder. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 000000000..b0a56f39c --- /dev/null +++ b/docs/CHANGELOG.md @@ -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 diff --git a/readme.md b/readme.md index eaf3ca112..2f56a8a76 100644 --- a/readme.md +++ b/readme.md @@ -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