@synonymdev/pubky 0.2.1 → 0.4.0-rc.4

package/README.md

@@ -1,6 +1,6 @@
 # Pubky
 
-JavaScript implementation of [Pubky](https://github.com/pubky/pubky).
+JavaScript implementation of [Pubky](https://github.com/pubky/pubky-core) client.
 
 ## Table of Contents
 - [Install](#install)
@@ -21,10 +21,10 @@ For Nodejs, you need Node v20 or later.
 ## Getting started
 
 ```js
-import { PubkyClient, Keypair, PublicKey } from '../index.js'
+import { Client, Keypair, PublicKey } from '../index.js'
 
-// Initialize PubkyClient with Pkarr relay(s).
-let client = new PubkyClient();
+// Initialize Client with Pkarr relay(s).
+let client = new Client();
 
 // Generate a keypair
 let keypair = Keypair.random();
@@ -42,31 +42,40 @@ let url = `pubky://${publicKey.z32()}/pub/example.com/arbitrary`;
 // Verify that you are signed in.
 const session = await client.session(publicKey)
 
-const body = Buffer.from(JSON.stringify({ foo: 'bar' }))
-
 // PUT public data, by authorized client
-await client.put(url, body);
+await client.fetch(url, { 
+    method: "PUT",
+    body: JSON.stringify({foo: "bar"}),
+    credentials: "include"
+});
 
 // GET public data without signup or signin
 {
-    const client = new PubkyClient();
+    const client = new Client();
 
-    let response = await client.get(url);
+    let response = await client.fetch(url);
 }
 
 // Delete public data, by authorized client
-await client.delete(url);
+await client.fetch(url, { method: "DELETE", credentials: "include "});
 ```
 
 ## API
 
-### PubkyClient
+### Client
 
 #### constructor
 ```js
-let client = new PubkyClient()
+let client = new Client()
+```
+
+#### fetch
+```js
+let response = await client.fetch(url, opts);
 ```
 
+Just like normal Fetch API, but it can handle `pubky://` urls and `http(s)://` urls with Pkarr domains.
+
 #### signup
 ```js
 await client.signup(keypair, homeserver)
@@ -127,27 +136,6 @@ let session = await client.session(publicKey)
 - publicKey: An instance of [PublicKey](#publickey).
 - Returns: A [Session](#session) object if signed in, or undefined if not.
 
-#### put
-```js
-let response = await client.put(url, body);
-```
-- url: A string representing the Pubky URL.
-- body: A Buffer containing the data to be stored.
-
-### get
-```js
-let response = await client.get(url)
-```
-- url: A string representing the Pubky URL.
-- Returns: A Uint8Array object containing the requested data, or `undefined` if `NOT_FOUND`.
-
-### delete
-
-```js
-let response = await client.delete(url);
-```
-- url: A string representing the Pubky URL.
-
 ### list
 ```js
 let response = await client.list(url, cursor, reverse, limit)
@@ -257,10 +245,10 @@ Run the local testnet server
 npm run testnet
 ```
 
-Use the logged addresses as inputs to `PubkyClient`
+Use the logged addresses as inputs to `Client`
 
 ```js
-import { PubkyClient } from '../index.js'
+import { Client } from '../index.js'
 
-const client = PubkyClient().testnet();
+const client = Client().testnet();
 ```