From 75862ed54fc6d428e93db3d630d54c6fcf7d42af Mon Sep 17 00:00:00 2001 From: Bucur David Date: Wed, 17 Jan 2024 11:20:30 +0200 Subject: [PATCH] docs: update readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2463879 --- /dev/null +++ b/README.md @@ -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 `node@19.7X` +- `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.