Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bucurdavid committed Jan 17, 2024
1 parent 982bb0d commit 75862ed
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SDK MX - Data Marshal Network

[![npm (scoped)](https://img.shields.io/npm/v/@itheum/sdk-data-marshal-network)](https://www.npmjs.com/package/@itheum/sdk-data-marshal-network)

This SDK is currently focused on interacting with the Itheum's Data Marshal Network.

## Contributing

- requires `[email protected]`
- `npm install`
- work on typescript code in the `/src` folder

### Dev Testing

- Only simple dev testing added. First **Build** as below and then run `npm run test` and work on the test.mjs file for live reload

### Build

- `npm run build`
- New build is sent to `dist` folder

## Usage in 3rd party dApps

- Install this SDK via `npm i @itheum/sdk-data-marshal-network`
- Methods supported are given below is `SDK Docs`

## SDK DOCS

- Generated docs available here: https://itheum.github.io/sdk-data-marshal-network/
- Note that all param requirements and method docs are marked up in the typescript code, so if you use typescript in your project your development tool (e.g. Visual Studio Code) will provide intellisense for all methods and functions.

0 comments on commit 75862ed

Please sign in to comment.