add some clarifications to the readme

Author: collapsinghierarchy

README.md

@@ -1,32 +1,33 @@
 # noisytransfer-cli
 
-Fast E2EE WebRTC file transfer (DTLS by default, optional PQ) with human-readable pairing codes.
+Fast end-to-end encrypted (E2EE) file transfer over WebRTC with short, human-readable pairing codes. The CLI speaks DTLS by default and can opt-in to a post-quantum (PQ) handshake with SAS confirmation.
 
-- Post-quantum (PQ) mode with SAS verification for authenticated setup.
-- Fast, E2EE transfers over WebRTC data channels (DTLS by default).
-- Code-based rendezvous (no accounts or prior pairing).
-- Single file, directory, or multiple paths (multi-path → `.tar` on the wire).
-- Prebuilt binaries for Linux/macOS/Windows, or build from source.
+## Installation
 
-## Install
+Requires Node.js **22 or newer** for development builds.
 
 ### npm
 
 ```bash
-npm i -g noisytransfer-cli
+# CLI (global)
+npm i -g @noisytransfer/cli
 # or as a lib:
-npm i noisytransfer-cli
+
+# library usage (local dependency)
+npm i @noisystransfer/cli
+
+# quick try without installing
+npx noisytransfer-cli --help
 ```
 
 ### Binaries
 
-Download from your releases (or build locally):
+Download the latest release artifacts or build them locally:
 
 ```bash
 # local build
 npm run build
-npm run pkg
-# binaries in ./release or ./dist (based on your scripts)
+npm pack
 ```
 
 ## Quick start
@@ -44,9 +45,9 @@ nt send report.pdf ./docs ./assets
 You’ll see:
 
 ```
-Code: 49b47940
-  nt 49b47940
-  nt recv --code 49b47940 --relay http://127.0.0.1:40971
+Code: 4932
+  nt 4932
+  nt recv 4932 
 ```
 
 ### Receive
@@ -55,39 +56,22 @@ You can use **any** of the following:
 
 ```bash
 # simplest: positional shorthand
-nt 49b47940
+nt 4932
 
 # explicit command & code, default output = current dir
-nt recv 49b47940
-
-# or with an explicit output directory
-nt recv ./downloads 49b47940
-
-# or with the flag form
-nt recv ./downloads --code 49b47940
-
-# skip redeem if you already have the appID
-nt recv ./downloads --app 49b47940-0cb1-43b3-bdb9-6f7f31f9a47d
-```
-
-To write to stdout:
-
-```bash
-nt recv - --code 49b47940 > received.bin
+nt recv 4932
 ```
 
 ### Post-quantum (PQ) mode
 
-Append `-pq` to the code or pass `--pq`:
+Pass `--pq`:
 
 ```bash
 # sender prints "Code: 5527e74d-pq"
-nt send --pq ./big.iso
-
+nt send ./big.iso --pq
+> Code: 4932
 # receiver can use the suffix, or just --pq explicitly
-nt recv ./downloads 5527e74d-pq
-# or
-nt recv ./downloads --code 5527e74d --pq
+nt recv 1234-pq ./downloads 
 ```
 
 ## Behavior & flags
@@ -96,75 +80,9 @@ nt recv ./downloads --code 5527e74d --pq
 - Multi-path sends are **tarred**; receiver writes `bundle.tar`. If a file exists and `--overwrite` is not set, the receiver dedupes as `bundle-1.tar`, `bundle-2.tar`, …
 - `--overwrite`: replace existing file instead of deduping.
 - `-y, --yes`: auto-accept SAS (useful for non-interactive invocations). Does **not** imply `--overwrite`.
-- `--json`: JSON logs on stderr (all debug routed through the logger).
 - `-v` (repeatable): increase verbosity; includes `[NT_DEBUG]` traces.
 - Filenames are sanitized on the receiver (no path traversal / reserved names). Output directory is always the **receiver’s** choice.
 
-## Logging
-
-- Human-facing lines (stable for scripts/tests):
-  - `Code: …`, `nt …` hints
-  - `Receiving → …`
-  - SAS lines: `[SAS A] …`, `[SAS B] …`
-  - The two-column progress line
-
-- Debug: `-v` or `NT_DEBUG=1` (on stderr).
-- Structured: `--json` (each line is a JSON object on stderr).
-
-Example:
-
-```bash
-nt send ./file -v --json 2> send.jsonl
-```
-
-## Programmatic API
-
-```js
-import { send, recv, createCode, redeemCode } from "noisytransfer-cli";
-
-// receive into ./downloads (auto-redeem code)
-const r = await recv("./downloads", {
-  relay: "http://127.0.0.1:40971",
-  yes: true,
-  code: "49b47940",
-});
-// r = { bytesWritten, announcedBytes, label, path, mode, appID }
-
-await send(["./file.txt"], { relay: "http://127.0.0.1:40971", yes: true });
-```
-
-TypeScript types are included. Key shapes:
-
-```ts
-type Mode = "dtls" | "pq";
-
-interface CommonOpts {
-  relay?: string;
-  headers?: Record<string, string>;
-  pq?: boolean;
-  yes?: boolean;
-}
-interface SendOptions extends CommonOpts {
-  app?: string;
-  name?: string;
-  stdinName?: string;
-  size?: number;
-}
-interface RecvOptions extends CommonOpts {
-  app?: string;
-  overwrite?: boolean;
-}
-
-interface RecvResult {
-  bytesWritten: number;
-  announcedBytes: number;
-  label: string | null;
-  path: string | null;
-  mode: Mode;
-  appID: string;
-}
-```
-
 ## Build from source
 
 Requirements: Node 18+.
@@ -180,15 +98,7 @@ npm test
 npm run build
 
 # make standalone binaries (Linux/macOS/Windows)
-npm run pkg
-```
-
-If your CI uses `npm ci`, commit `package-lock.json`:
-
-```bash
-npm i --package-lock-only
-git add package-lock.json
-git commit -m "chore: lockfile"
+npm pack
 ```
 
 ## Security model (short)
@@ -197,12 +107,6 @@ git commit -m "chore: lockfile"
 - Rendezvous codes are short-lived; both sides display a 6-digit SAS you can compare out-of-band.
 - The receiver owns the destination directory; announced filenames are sanitized to safe **leaf** names.
 
-## Troubleshooting
-
-- **“recv: either --code or --app is required”** – pass a code: `nt recv ./out --code <8-hex>` or just `nt <code>`.
-- **NAT / firewalls** – set `--relay` to your reachable rendezvous service.
-- **Windows** – native WebRTC addon is embedded; if you build locally, ensure the `.node` is present in `assets/native/win32-*` (your scripts copy these into `dist/assets/native/...` for the binary).
-
 ## Future features
 Status: currently disabled/broken; will be re-enabled with proper tests.
 
@@ -235,7 +139,6 @@ cat report.pdf | nt send - --stdin-name report.pdf
 # default would be "stdin.bin" if omitted
 ```
 
-
 ## License
 
 AGPL-3.0-only

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "noisytransfer-cli",
+  "name": "@noisytransfer/cli",
   "version": "0.2.1",
   "description": "Fast E2EE WebRTC file transfer (DTLS by default, optional PQ) with human-readable pairing codes.",
   "license": "AGPL-3.0-only",