Merge pull request #2269 from PR0M3TH3AN/ai/docs-update-YYYYMMDD-14830176725962332143

Update documentation quickstart and contributing guides

README.md

@@ -165,7 +165,16 @@ To run **bitvid** locally:
 
    _(Note: The default port is 3000, but `npx serve` may select a different port if 3000 is in use. Check your terminal output.)_
 
-   _Note: If you prefer manual steps, you can run `npm run build` followed by `npx serve dist`._
+   _Note: If you prefer manual steps, you can run `npm run build` followed by `npx serve dist` (or `cd dist && python3 -m http.server`)._
+
+5. Verify setup:
+
+   Run tests and linting to ensure everything is working correctly.
+
+   ```bash
+   npm run test:unit
+   npm run format
+   ```
 
 #### Quick Reference
 
@@ -257,7 +266,7 @@ const event = buildVideoPostEvent({
 
 console.log("Event constructed:", event);
 
-// 2. Publish using the high-level client (requires browser/extension or active signer)
+// 2. Publish the event (requires browser/extension or active signer)
 /*
 import { nostrClient } from "./js/nostrClientFacade.js";
 
@@ -265,14 +274,10 @@ import { nostrClient } from "./js/nostrClientFacade.js";
 await nostrClient.init();
 
 // Login (prompts NIP-07 extension)
-await nostrClient.login();
+await nostrClient.loginWithExtension();
 
-// Publish! (Handles signing and relay broadcasting)
-await nostrClient.publishVideo({
-  title: "My First Video",
-  url: "https://example.com/video.mp4",
-  description: "Published via bitvid SDK"
-}, nostrClient.pubkey);
+// Publish the built event
+await nostrClient.signAndPublishEvent(event);
 */
 ```
 

tests/unit/client-count-resilience.test.mjs

@@ -39,7 +39,7 @@ test("NostrClient resilience to COUNT timeouts", async (t) => {
   client.getRequestTimeoutMs = () => 10; // 10ms timeout
 
   // Verify initial state
-  assert.strictEqual(client.unreachableRelays.has(relayUrl), false);
+  assert.strictEqual(client.connectionManager.unreachableRelays.has(relayUrl), false);
 
   // Trigger the count
   await client.countEventsAcrossRelays([{ kinds: [1] }]);
@@ -51,7 +51,7 @@ test("NostrClient resilience to COUNT timeouts", async (t) => {
   // 3. countEventsAcrossRelays catches 'count-timeout'
   // 4. currently calls markRelayUnreachable
 
-  const isUnreachable = client.unreachableRelays.has(relayUrl);
+  const isUnreachable = client.connectionManager.unreachableRelays.has(relayUrl);
 
   assert.strictEqual(isUnreachable, false, "Relay should NOT be marked unreachable after count timeout");
 });