@synonymdev/pubky 0.0.1 → 0.0.3

package/README.md

@@ -11,7 +11,7 @@ npm install @synonymdev/pubky
 ## Getting started
 
 ```js
-import PubkyClient from "@synonymdev/pubky";
+import { PubkyClient, Keypair, PublicKey } from '../index.js'
 
 // Initialize PubkyClient with Pkarr relay(s).
 let client = new PubkyClient();
@@ -20,9 +20,26 @@ let client = new PubkyClient();
 let keypair = Keypair.random();
 
 // Create a new account
-let homeserver = PublicKey.try_from("8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo");
+let homeserver = PublicKey.from("8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo");
 
 await client.signup(keypair, homeserver)
+
+const publicKey = keypair.public_key();
+
+// 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(publicKey, "/pub/example.com/arbitrary", body);
+
+// GET public data without signup or signin
+{
+    const client = new PubkyClient();
+
+    let response = await client.get(publicKey, "/pub/example.com/arbitrary");
+}
 ```
 
 ## Test and Development
@@ -39,11 +56,21 @@ Clone the Pubky repository:
 
 ```bash
 git clone https://github.com/pubky/pubky
-cd pubky/
+cd pubky/pkg
 ```
 
-Run the testnet server
+Run the local testnet server
 
 ```bash
-cargo run --bin pubky_homeserver -- --testnet
+npm run testnet
+```
+
+Pass the logged addresses as inputs to `PubkyClient`
+
+```js
+import { PubkyClient, PublicKey } from '../index.js'
+
+const client = new PubkyClient().setPkarrRelays(["http://localhost:15411/pkarr"]);
+
+let homeserver = PublicKey.from("8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo");
 ```

package/package.json

@@ -2,18 +2,20 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Pubky client",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/pubky/pubky"
   },
   "scripts": {
-    "lint": "standard --fix",
-    "test": "tape test/*.js -cov",
+    "testnet": "cargo run -p pubky_homeserver -- --testnet",
+    "test": "npm run test-nodejs && npm run test-browser",
+    "test-nodejs": "tape test/*.js -cov",
     "test-browser": "browserify test/*.js -p esmify | npx tape-run",
-    "preinstall": "cargo run --bin bundle_pubky_npm",
-    "prepublishOnly": "npm run lint && npm run test"
+    "build": "cargo run --bin bundle_pubky_npm",
+    "preinstall": "npm run build",
+    "prepublishOnly": "npm run build && npm run test"
   },
   "files": [
     "nodejs/*",
@@ -36,7 +38,6 @@
   "devDependencies": {
     "browser-resolve": "^2.0.0",
     "esmify": "^2.1.1",
-    "standard": "^17.1.0",
     "tape": "^5.8.1",
     "tape-run": "^11.0.0"
   }