feat():Readme update

tiagosiebler · Sep 23, 2024 · b5a5f74 · b5a5f74
1 parent ac5159d
commit b5a5f74
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -105,6 +105,7 @@ import { CBAdvancedTradeClient } from 'coinbase-api';
 
 // insert your API key details here from Coinbase API Key Management
 const advancedTradeCdpAPIKey = {
+  // dummy example keys to understand the structure
   name: 'organizations/13232211d-d7e2-d7e2-d7e2-d7e2d7e2d7e2/apiKeys/d7e2d7e2-d7e2-d7e2-d7e2-d7e2d7e2d7e2',
   privateKey:
     '-----BEGIN EC PRIVATE KEY-----\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+oAoGCCqGSM49\nAwEHoUQDQgAEhtAep/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+bzduY3iYXEmj/KtCk\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj\n-----END EC PRIVATE KEY-----\n',
@@ -133,7 +134,9 @@ try {
 ```javascript
 const { CBAppClient } = require('coinbase-api');
 
+// insert your API key details here from Coinbase API Key Management
 const CBAppKeys = {
+  // dummy example keys to understand the structure
   name: 'organizations/13232211d-d7e2-d7e2-d7e2-d7e2d7e2d7e2/apiKeys/d7e2d7e2-d7e2-d7e2-d7e2-d7e2d7e2d7e2',
   privateKey:
     '-----BEGIN EC PRIVATE KEY-----\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+oAoGCCqGSM49\nAwEHoUQDQgAEhtAep/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+bzduY3iYXEmj/KtCk\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj\n-----END EC PRIVATE KEY-----\n',