From 5855652326fabb83cc2b3320e63aa15753ee213c Mon Sep 17 00:00:00 2001 From: Sai Kranthi <57343520+kranthicodes@users.noreply.github.com> Date: Tue, 27 Jun 2023 08:28:40 +0530 Subject: [PATCH] chore(docs): Create README.md --- packages/sdk/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 packages/sdk/README.md diff --git a/packages/sdk/README.md b/packages/sdk/README.md new file mode 100644 index 00000000..5c35688b --- /dev/null +++ b/packages/sdk/README.md @@ -0,0 +1,22 @@ +# Ordit-SDK + +A TypeScript SDK for Bitcoin and Ordinals. + +[![NPM Version](https://img.shields.io/npm/v/@sadoprotocol/ordit-sdk?color=33cd56&logo=npm)](https://www.npmjs.com/package/@sadoprotocol/ordit-sdk) + +## Installation + +Ordit-SDK is available as a NPM package. + +```text +npm install @sadoprotocol/ordit-sdk +``` + +## Usage + +You can interact with Ordit-SDK using `ordit` object exposed from the package. + +```text +import { ordit } from '@sadoprotocol/ordit-sdk' +``` +