@synonymdev/pubky 0.1.10 → 0.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -110,10 +110,20 @@ let response = await client.get(url)
110
110
  ### delete
111
111
 
112
112
  ```js
113
- let response = await delete(url);
113
+ let response = await client.delete(url);
114
114
  ```
115
115
  - url: A string representing the Pubky URL.
116
116
 
117
+ ### list
118
+ ```js
119
+ let response = await client.list(url, cursor, reverse, limit)
120
+ ```
121
+ - url: A string representing the Pubky URL. The path in that url is the prefix that you want to list files within.
122
+ - cursor: Usually the last URL from previous calls. List urls after/before (depending on `reverse`) the cursor.
123
+ - reverse: Whether or not return urls in reverse order.
124
+ - limit: Number of urls to return.
125
+ - Returns: A list of URLs of the files in the `url` you passed.
126
+
117
127
  ### Keypair
118
128
 
119
129
  #### random
@@ -186,5 +196,5 @@ Use the logged addresses as inputs to `PubkyClient`
186
196
  ```js
187
197
  import { PubkyClient } from '../index.js'
188
198
 
189
- const client = new PubkyClient().testnet();
199
+ const client = PubkyClient().testnet();
190
200
  ```