Skip to content

Commit

Permalink
Add Comment to readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TrustHenry authored and MichaelKim20 committed Jul 13, 2020
1 parent 594d10d commit 522d824
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# boa-sdk-ts
SDK to interface with the BOSAGORA blockchain
boa-sdk-ts is a TypeScript/JavaScript library for communicating with the Stoa API server.
It also has utility functions such as hashing and pre-image validation.

## Install
```bash
$ npm install --save boa-sdk-ts
```

## Import the your library
```import * as BoaSdk from "boa-sdk-ts";```

## Usage
```TypeScript
// Create BOA Client
let boa_client = new BoaSdk.BOAClient("http://localhost:3836");

// Query
boa_client.getValidator("GA3DMXTREDC4AIUTHRFIXCKWKF7BDIXRWM2KLV74OPK2OKDM2VJ235GN", 10)
.then((validators: Array<BoaSdk.Validator>) =>
{
// On Success
})
.catch(err =>
{
// On Error
});
```

## Testing
```bash
$ git clone https://github.com/bpfkorea/boa-sdk-ts.git
$ npm install
$ npm run build
$ npm test
```

0 comments on commit 522d824

Please sign in to comment.