@freerdp-bridge/fastify 0.2.1 → 0.2.2

package/README.md

@@ -1,25 +1,38 @@
 # FreeRDP Browser Bridge — Fastify
 
+## Purpose
+
 Mount RDP HTTP and WebSocket routes inside an existing Fastify 5 application,
 on its existing port. Each session runs a separate native worker; FreeRDP does
-not run inside Node.js. Requires Node.js 24.
+not run inside Node.js. Package name: `@freerdp-bridge/fastify`.
+
+## Installation
 
 Install the adapter and the matching native runtime version for your server:
 
 ```sh
 # Linux x64 / glibc
-npm install fastify@5.12.5 @freerdp-bridge/fastify@0.2.1 @freerdp-bridge/runtime-linux-x64-gnu@0.2.1
+npm install fastify@5.12.5 @freerdp-bridge/fastify@0.2.2 @freerdp-bridge/runtime-linux-x64-gnu@0.2.2
 
 # Windows x64
-npm install fastify@5.12.5 @freerdp-bridge/fastify@0.2.1 @freerdp-bridge/runtime-win32-x64@0.2.1
+npm install fastify@5.12.5 @freerdp-bridge/fastify@0.2.2 @freerdp-bridge/runtime-win32-x64@0.2.2
 ```
 
 For an unreleased source checkout, use locally built tarballs instead;
 a source version number alone does not establish registry availability.
+## Requirements
+
+Requires Node.js 24, ESM, Fastify 5 and a native runtime of the same product
+version as all JS bridge packages. Install the runtime explicitly.
 Runtime packages include their private native libraries, helpers and notices.
+This adapter contains JavaScript/declarations; the compiled C++ worker and
+native IPC components are supplied by the separate platform runtime, not by
+the adapter. The runtime also carries its third-party source companions.
 They require no compiler or network installation script. Node/browser binaries
 are separate prerequisites. macOS, ARM and musl are not supported by this set.
 
+## Usage
+
 ```ts
 import Fastify from 'fastify';
 import { rdpBridgePlugin, resolveNativeRuntime } from '@freerdp-bridge/fastify';
@@ -44,6 +57,8 @@ Cookie-based identity needs a separate CSRF/Origin adapter and is currently
 refused. On Windows, use an absolute Windows path for runtimeRoot. The host
 owns external TLS and access logging; exclude credentials and attach URL tokens.
 
+## Limitations
+
 The plugin validates bodies strictly within 64 KiB, preserves session ownership,
 uses single-use control/media tokens, and verifies RDP certificates strictly by
 default. Inspect `/rdp/v1/build` and `/rdp/v1/capabilities` for the actual native
@@ -70,5 +85,7 @@ The host owns presentation, identity and browser permission policy.
 
 Complete source-tree guides are `docs/FASTIFY_USAGE.md` and
 `docs/NATIVE_NPM_RUNTIME.md`; the public `.d.ts` files describe the options.
-Project-owned code uses MIT. Native dependencies retain their own licenses in
+## License
+
+Project-owned code uses MIT (LICENSE). Native dependencies retain their own licenses in
 the platform runtime package's THIRD_PARTY_NOTICES.md and bundled notices.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freerdp-bridge/fastify",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "type": "module",
   "license": "MIT",
   "engines": {
@@ -8,7 +8,8 @@
   },
   "files": [
     "dist",
-    "LICENSE"
+    "LICENSE",
+    "README.md"
   ],
   "exports": {
     ".": {
@@ -21,7 +22,7 @@
     }
   },
   "dependencies": {
-    "@freerdp-bridge/api": "0.2.1"
+    "@freerdp-bridge/api": "0.2.2"
   },
   "peerDependencies": {
     "fastify": "^5.12.5"