chore: updated readme with examples

.vscode/settings.json

@@ -17,7 +17,7 @@
     "editor.defaultFormatter": "biomejs.biome"
   },
   "editor.codeActionsOnSave": {
-    "source.organizeImports.biome": true,
-    "quickfix.biome": true
+    "source.organizeImports.biome": "explicit",
+    "quickfix.biome": "explicit"
   }
 }

README.md

@@ -1,7 +1,36 @@
-# SDK
+# Numo.ts
+
+Numo.ts is a TypeScript library for interacting with the Numo marketplace for efficiently buying and selling [European-style](https://en.wikipedia.org/wiki/European_option) call options.
+
+## Installation
+
+```bash
+npm install --save @numotrade/numo-ts
+```
+
+## Getting Started
+
+Instantiate your of Numo using your etheres provider:
+
+### Examples
+
+#### Through a RPC Provider (i.e. QuickNode) 
+
+```typescript
+import { Numo } from "@numotrade/numo-ts";
+import { ethers } from "ethers";
+
+const provider = new ethers.JsonRpcProvider(process.env.RPC_URL);
+
+const numo = new Numo(provider);
+```
+
+#### Exercising a ERC-20 call option
+
+
+
+
+
+
 
-The Numoen© software development kit (SDK) offers developer tools to interact with various automated market makers and liquidity management protocols on the Ethereum Virtual Machine (EVM).
 
-- [x] Numoen V1
-- [x] Uniswap V3
-- [x] Panoptic V1