@synonymdev/pubky 0.1.15 → 0.1.16

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
@@ -98,7 +98,7 @@ let [pubkyauthUrl, sessionPromise] = client.authRequest(relay, capabilities);
98
98
 
99
99
  showQr(pubkyauthUrl);
100
100
 
101
- let session = await sessionPromise;
101
+ let pubky = await sessionPromise;
102
102
  ```
103
103
 
104
104
  Sign in to a user's Homeserver, without access to their [Keypair](#keypair), nor even [PublicKey](#publickey),
@@ -109,7 +109,7 @@ instead request permissions (showing the user pubkyauthUrl), and await a Session
109
109
 
110
110
  Returns:
111
111
  - pubkyauthUrl: A url to show to the user to scan or paste into an Authenticator app holding the user [Keypair](#keypair)
112
- - sessionPromise: A promise that resolves into a [Session](#session) on success.
112
+ - sessionPromise: A promise that resolves into a [PublicKey](#publickey) on success, which you can use in `client.session(pubky)` to resolve more information about the Session.
113
113
 
114
114
  #### sendAuthToken
115
115
  ```js
@@ -139,7 +139,7 @@ let response = await client.put(url, body);
139
139
  let response = await client.get(url)
140
140
  ```
141
141
  - url: A string representing the Pubky URL.
142
- - Returns: A response object containing the requested data.
142
+ - Returns: A Uint8Array object containing the requested data, or `undefined` if `NOT_FOUND`.
143
143
 
144
144
  ### delete
145
145