@beekeeper/home-screen-sdk
v0.10.0
Published
The Home Screen SDK provides a widget with essential functionality to be shown on the Home Screen inside the Beekeeper mobile app. For more details, please have a look at related [Developer Portal page]().
Downloads
170
Maintainers
Keywords
Readme
Home Screen SDK
The Home Screen SDK provides a widget with essential functionality to be shown on the Home Screen inside the Beekeeper mobile app. For more details, please have a look at related Developer Portal page.
This package can be used in two different ways:
- Interaction with Home Screen on the mobile device
- Generating injectable code snipped for development environment
generate-bridge-config
Get Started
To get started, run the following command in your widget's development environment:
yarn add @beekeeper/home-screen-sdk
or
npm install @beekeeper/home-screen-sdk
Usage
Please see the developer documentation for usage hints.
Development notes
This section covers working on the SDK itself and can be glossed over if you're just using the SDK.
Updating type definitions for the Mobile Bridge
The Home Screen SDK has type definitions of the Mobile Bridge bundled in src/mobile-bridge-types
due to the bridge's implementation not being public. To update the type definitions, run bin/update-bridge-types
and commit the changes. Access to Beekeeper's internal NPM registry is required to do that:
$ yarn install
$ bin/update-bridge-types