chore(docs): Create README.md

sadoprotocol · Jun 27, 2023 · 5855652 · 5855652
1 parent 52935a4
commit 5855652
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/packages/sdk/README.md 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'
+```
+