Skip to content

square/site-theme-sdk

Repository files navigation

Site Theme SDK

semantic-release: conventionalcommits

Code Coverage

Statements Branches Functions Lines
Statements Branches Functions Lines

Usage

See Getting Started.

Install

Note: This is a pre-public library and not available on any registries yet, please install the library via:

$ npm install https://github.com/square/site-theme-sdk

If you have a specific release you want install, include the version: e.g. https://github.com/square/site-theme-sdk#v1.0.0-alpha.1.

Alternatively, you can download them directly via the Github Releases.

On official release, we'll publish this to the public registries.

Local Setup

$ nvm use
$ npm ci
$ npm run build

The built SDK will be available in the ./lib folder.

Contributing

Please make sure to read the Contributing Guide before making a pull request.

About

A lightweight, open source JavaScript SDK that wraps basic asynchronous functionality of Custom Site client APIs as well as additional helper functionality.

Resources

License

Stars

Watchers

Forks

Packages

No packages published