diff --git a/README.md b/README.md index 0ca1bf72..baf740f3 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,31 @@ The code is built using Typescript and running code locally requires a Mac or Li Typescript source files needs to be transpiled before running scripts or integration tests - Build: + ```bash npm run build ``` +- ready() must be called before library is useable. Example minimum viable client code. + + ```javascript + import { randomPasscode, ready, SignifyClient, Tier } from 'signify-ts'; + + await ready(); + + const bran = randomPasscode(); + const url = 'http://127.0.0.1:3901'; + const boot_url = 'http://127.0.0.1:3903'; + const actualSignifyClient = new SignifyClient( + url, + bran, + Tier.low, + boot_url + ); + + console.log(actualSignifyClient); + ``` + ### Unit testing To run unit tests