@neutral-trade/sdk 0.2.5 → 0.2.7

package/README.md

@@ -67,6 +67,15 @@ See the [documentation](https://sdk.neutral.trade) for the complete list of vaul
 
 The SDK includes built-in vault configurations, but you can also fetch the latest configurations from a remote registry. This is useful if you don't upgrade the SDK package frequently.
 
+Merge order is:
+
+- built-in configs
+- `registry` (local array you provide)
+- `registryUrl` (remote, highest priority)
+
+Use `bundleCluster` to select fixed default Bundle program ID by cluster (`mainnet` or `devnet`).
+If a vault entry includes `bundleProgramId`, that vault-specific program ID is used instead.
+
 ### Registry URLs
 
 - **GitHub Raw**: `https://raw.githubusercontent.com/neutral-trade/sdk/main/src/registry/vaults.json`
@@ -74,6 +83,24 @@ The SDK includes built-in vault configurations, but you can also fetch the lates
 
 ### Usage
 
+**Use a local registry array (good for custom/new vaults):**
+
+```typescript
+const sdk = await NeutralTrade.create({
+  rpcUrl: 'YOUR_RPC_URL_HERE',
+  registry: [
+    {
+      vaultId: 9999,
+      name: 'My Custom Vault',
+      type: 'Bundle',
+      category: 'Market Neutral',
+      vaultAddress: 'YOUR_VAULT_ADDRESS',
+      depositToken: 'USDC'
+    }
+  ]
+})
+```
+
 **Use the registry URL if you don't upgrade the SDK frequently:**
 
 ```typescript
@@ -85,6 +112,19 @@ const sdk = await NeutralTrade.create({
 
 This ensures you always have the latest vault configurations without needing to update the SDK package.
 
+**Use both local + registry URL (URL overrides local when same vaultId exists):**
+
+```typescript
+const sdk = await NeutralTrade.create({
+  rpcUrl: 'YOUR_RPC_URL_HERE',
+  registry: [
+    // Local overrides built-in
+  ],
+  registryUrl: 'https://cdn.jsdelivr.net/gh/neutral-trade/sdk@main/src/registry/vaults.json'
+  // Remote overrides local
+})
+```
+
 **Use built-in configs if you upgrade the SDK regularly:**
 
 ```typescript
@@ -94,6 +134,15 @@ const sdk = await NeutralTrade.create({
 })
 ```
 
+**Select devnet default Bundle program ID:**
+
+```typescript
+const sdk = await NeutralTrade.create({
+  rpcUrl: 'YOUR_RPC_URL_HERE',
+  bundleCluster: 'devnet'
+})
+```
+
 This is simpler and doesn't require an additional network request at initialization.
 
 ## Examples