README.md

Tinlake JavaScript Client

Usage

Documentation can be found in ./docs/ or at https://centrifuge.github.io/tinlake.js/.

Development

Install dependencies with npm install.

Running tests

Run unit and integration tests at once with npm test or separate with npm run test-unit and npm run test-integration.

Building for production

Create a bundle in the ./dist folder with npm run build.

Creating documentation

We use TypeDoc for documentation. Run npm run generate-docs to recreate the ./docs/ folder. Checkout TSDoc for formatting guidelines.