Skip to content

Latest commit

Β 

History

History
40 lines (25 loc) Β· 910 Bytes

File metadata and controls

40 lines (25 loc) Β· 910 Bytes

BrightID SDK for Applications

A typescript library for simplifying integration of applications with BrightID

πŸŽ‰ Features

Exposes all necessary functions for integrating an application with BrightID as well as testing methods to make sure its all working.

βš™ Install

#npm
npm i brightid_sdk_v6

# yarn
yarn add brightid_sdk_v6

πŸ“– Docs

You can read docs here, just remember to run the npm run docs script.

Contributing

PRs always welcome!

Predefined scripts in package.json:

  • changelog: creates a changelog (using standard-changelog)
  • docs: creates docs from your jsdocs
  • lint: lints your code
  • prepublishOnly: builds your sources for deployment (to npm)
  • size-limit: checks your bundle size limit
  • test: run tests
  • upgrade-interactive: upgrades your dependencies interactively (like with yarn)

πŸ“ƒ Licence

Read the licence