README.md

Betty Component SDK

A collection of APIs to develop on the Betty Blocks platform

Documentation

API docs

Guides

Generate documentation locally:

    yarn build:docs

Installation

Install the sdk with npm:

  npm install @betty-blocks/component-sdk --also=dev

Install the sdk with yarn:

  yarn add -D @betty-blocks/component-sdk

Running Tests

To run tests, run the following command:

  yarn test

Development Notes

Please add unit tests for all new functionality.

You can use yarn link to test this package locally to make sure it performs as expected.