ferrings 0.1.0

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative
+    Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!) The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2026 ferrings contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ferrings contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,428 @@
+# ferrings
+
+[![CI](https://github.com/avifenesh/ferrings/actions/workflows/ci.yml/badge.svg)](https://github.com/avifenesh/ferrings/actions/workflows/ci.yml)
+[![Release](https://github.com/avifenesh/ferrings/actions/workflows/release.yml/badge.svg)](https://github.com/avifenesh/ferrings/actions/workflows/release.yml)
+![Node.js >=20](https://img.shields.io/badge/node-%3E%3D20-339933)
+![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)
+
+Linux `io_uring` TCP transport for Node.js, built with Rust and napi-rs for high-concurrency server outside libuv's networking loop.
+
+ferrings exposes Node-friendly TCP and fixed-response HTTP APIs backed by a native `io_uring` worker: multishot accept/recv, provided buffer rings, recv-bundle, zero-copy send, and an optional ZCRX path for capable NICs. The project is at the 0.1.0 release stage; tag pushes build native artifacts and publish to npm through the repository `NPM_TOKEN` secret.
+
+```bash
+git clone https://github.com/avifenesh/ferrings.git
+cd ferrings
+npm install
+npm run build
+```
+
+```js
+const net = require('node:net');
+const { createTcpServer } = require('./');
+
+const server = createTcpServer((connection) => {
+  connection.on('data', (data) => connection.end(`ferrings:${data}`));
+});
+
+server.listen(0, '127.0.0.1', (info) => {
+  const client = net.createConnection(info.port, info.host, () => client.write('ping'));
+  client.on('data', (data) => {
+    console.log(data.toString());
+    server.close();
+  });
+});
+```
+
+Run the example from the repository root with `node quickstart.js`; it prints `ferrings:ping`. After npm publishing, replace `require('./')` with `require('ferrings')`.
+
+## Quick proof signals
+
+- Linux-only native addon for Node.js `>=20`, written in Rust with napi-rs.
+- CI builds and tests Node 20, 22, and 24 on Linux.
+- Release workflow builds native packages for `linux-x64-gnu`, `linux-x64-musl`, `linux-arm64-gnu`, and `linux-arm64-musl`.
+- `npm run check:release-ready -- --full --strict` reports `ready-with-optional-blockers`; the optional blocker is ZCRX hardware proof.
+- Package install smoke tests pack the tarball, install it in a temporary app, start a TCP server through `require('ferrings')`, and run the installed CLI.
+
+## Why this project
+
+- Use this when you want to compare Node's `net` / `http` servers with a modern Linux `io_uring` TCP path.
+- Use this when you need a Node API over a Rust-native networking worker for high-concurrency Linux experiments.
+- Use this when you want runtime visibility into kernel features such as multishot recv, provided buffer rings, recv-bundle, zero-copy send, and ZCRX readiness.
+- Use this when you want to benchmark syscall counts, tail latency, and queue behavior without building a native addon from scratch.
+- Use this when you are exploring ZCRX, but want the broadly usable core to work on machines without ZCRX-capable NIC hardware.
+
+## Installation
+
+The npm package family is prepared but not published yet. Use the source checkout path for now:
+
+```bash
+git clone https://github.com/avifenesh/ferrings.git
+cd ferrings
+npm install
+npm run build
+npm test
+```
+
+When the npm packages are published, the intended install path is:
+
+```bash
+npm install ferrings
+```
+
+The base package is Linux-only and depends on optional native packages for glibc/musl and x64/arm64 targets.
+
+## Quick start
+
+Create `quickstart.js` in the repository root:
+
+```js
+'use strict';
+
+const net = require('node:net');
+const { createTcpServer, capabilities } = require('./');
+
+console.log(capabilities());
+
+const server = createTcpServer((connection) => {
+  connection.on('data', (data) => {
+    connection.end(Buffer.concat([Buffer.from('echo:'), data]));
+  });
+});
+
+server.listen(
+  {
+    host: '127.0.0.1',
+    port: 0,
+    backlog: 1024,
+    useRecvBundle: true,
+    useZeroCopySend: true
+  },
+  (info) => {
+    console.log(`listening on tcp://${info.host}:${info.port}`);
+
+    const client = net.createConnection({ host: info.host, port: info.port }, () => {
+      client.write('hello');
+    });
+
+    let body = Buffer.alloc(0);
+    client.on('data', (chunk) => {
+      body = Buffer.concat([body, chunk]);
+    });
+    client.on('end', () => {
+      console.log(body.toString('utf8'));
+      server.close();
+    });
+  }
+);
+```
+
+Run it:
+
+```bash
+node quickstart.js
+```
+
+What happened:
+
+- `createTcpServer()` created a Node-style TCP server backed by a native `io_uring` worker.
+- `capabilities()` printed the active kernel probes for this host.
+- `useRecvBundle` and `useZeroCopySend` were requested, but remain capability-gated by the native addon.
+- The client received `echo:hello` and the server shut down.
+
+## Core concepts
+
+ferrings is not a wrapper around Node's libuv TCP implementation. It creates the listening socket directly with `socket`, `bind`, and `listen`, then drives accepts, receives, sends, and shutdown from a Rust worker thread with `io_uring`.
+
+JavaScript stays in control of the application API:
+
+- Native to JS events are delivered through NAPI thread-safe callbacks.
+- JS to native writes go through a bounded command queue and an `eventfd` wakeup.
+- Server counters are exposed through `info()` and the initial `ServerInfo` returned by `start()` / `listen()`.
+- Kernel-specific features are probed at runtime instead of assumed.
+
+The broad core path is multishot accept + multishot recv + provided buffers. ZCRX is intentionally separate: it requires kernel support, NIC header/data split, flow steering/RSS isolation, permissions, and a capable RX queue.
+
+## Features
+
+- Node-style TCP server facade with `connection`, `data`, `close`, `write()`, `end()`, `destroy()`, `address()`, and `getConnections()`.
+- Raw `UringTcpServer` for lower-level event handling, batched event delivery, and batched sends.
+- `UringTcpEchoServer` for native TCP echo benchmarks without per-connection JS callbacks.
+- `UringHttpServer` for fixed-response HTTP benchmarks on the cleanest `io_uring` path.
+- Multishot accept and recv for fewer per-operation submissions on supported kernels.
+- Provided buffer rings first, with `IORING_OP_PROVIDE_BUFFERS` fallback when registration is rejected.
+- Optional recv-bundle mode using `IORING_FEAT_RECVSEND_BUNDLE` when the kernel advertises it.
+- Optional zero-copy send using `IORING_OP_SEND_ZC`, with counters for requests, notifications, copied fallback, and errors.
+- Optional registered-buffer send path, guarded by an active startup probe.
+- Optional ZCRX path with `zcrxProbe()`, CLI diagnostics, active IFQ registration probe, and hardware smoke tests.
+- Bounded command, event, and per-connection send queues so overload is reported instead of growing memory without bound.
+
+## API and usage patterns
+
+### Node-style TCP
+
+```js
+const { createTcpServer } = require('./');
+
+const server = createTcpServer((connection) => {
+  connection.on('data', (data) => connection.end(data));
+});
+
+server.listen(0, '127.0.0.1', (info) => {
+  console.log(info);
+});
+```
+
+Use this path when you want a familiar Node server shape over the native transport.
+
+### Raw TCP events
+
+```js
+const { UringTcpServer } = require('./');
+
+const server = new UringTcpServer({
+  host: '127.0.0.1',
+  port: 0,
+  useRecvBundle: true,
+  useZeroCopySend: true
+});
+
+const info = server.start((event) => {
+  if (event.eventType === 'data') {
+    server.sendAndClose(event.connectionId, Buffer.from('pong'));
+  }
+});
+
+console.log(`tcp://${info.host}:${info.port}`);
+```
+
+Use this path when you want direct event objects and explicit connection IDs.
+
+### Batched TCP events and sends
+
+```js
+const { UringTcpServer } = require('./');
+
+const server = new UringTcpServer({ host: '127.0.0.1', port: 0 });
+
+const info = server.startBatch((events) => {
+  const sends = [];
+  for (const event of events) {
+    if (event.eventType === 'data') {
+      sends.push({ connectionId: event.connectionId, data: event.data });
+    }
+  }
+  if (sends.length > 0) {
+    server.sendBatchAndClose(sends);
+  }
+});
+
+console.log(`tcp://${info.host}:${info.port}`);
+```
+
+Use this path when JS callback overhead matters and events can be processed in batches.
+
+### Fixed-response HTTP
+
+```js
+const { UringHttpServer } = require('./');
+
+const server = new UringHttpServer({
+  host: '127.0.0.1',
+  port: 0,
+  responseBody: 'hello from ferrings\n',
+  useZeroCopySend: true
+});
+
+const info = server.start();
+console.log(`http://${info.host}:${info.port}`);
+```
+
+`UringHttpServer` is a benchmark server, not a general HTTP framework.
+
+### Native echo benchmark server
+
+```js
+const { UringTcpEchoServer } = require('./');
+
+const server = new UringTcpEchoServer({
+  host: '127.0.0.1',
+  port: 0,
+  useZeroCopySend: true
+});
+
+const info = server.start();
+console.log(`tcp://${info.host}:${info.port}`);
+```
+
+Use this to isolate the native TCP echo path from JavaScript event delivery.
+
+### Capability and ZCRX probes
+
+```js
+const { capabilities, zcrxProbe } = require('./');
+
+console.log(capabilities());
+console.log(zcrxProbe({ interfaceName: 'eth0' }));
+console.log(zcrxProbe({
+  interfaceName: 'eth0',
+  rxQueue: 0,
+  activeRegistration: true
+}));
+```
+
+The CLI exposes the same diagnostics from a source checkout:
+
+```bash
+node bin/ferrings.js capabilities --json
+node bin/ferrings.js doctor --interface eth0 --rx-queue 0 --active --json
+node bin/ferrings.js zcrx-probe --interface eth0 --rx-queue 0 --active --json
+```
+
+After npm publishing, the same commands can be run as `npx ferrings ...`.
+
+## Configuration
+
+Common server options:
+
+| Option | Default | Applies to | Purpose |
+| --- | ---: | --- | --- |
+| `host` | `127.0.0.1` | all servers | Bind address. |
+| `port` | `0` | all servers | Bind port; `0` asks the kernel for a free port. |
+| `backlog` | `1024` | all servers | Passed to `listen(2)`, subject to host `somaxconn`. |
+| `queueDepth` | `1024` | all servers | `io_uring` queue depth. |
+| `bufferCount` | `4096` | all servers | Receive buffer slots. |
+| `bufferSize` | `2048` | all servers | Size of each receive buffer. |
+| `maxConnections` | `0` | all servers | `0` means unlimited tracked active connections. |
+| `idleTimeoutMs` | `0` | all servers | `0` disables native idle eviction. |
+| `tcpNoDelay` | `true` | all servers | Applies `TCP_NODELAY` to accepted sockets. |
+| `reusePort` | `false` | all servers | Applies `SO_REUSEPORT` before bind. |
+| `tcpDeferAcceptSeconds` | `0` | all servers | Applies `TCP_DEFER_ACCEPT` when positive. |
+| `socketRecvBufferSize` | `0` | all servers | `SO_RCVBUF`; `0` keeps kernel defaults. |
+| `socketSendBufferSize` | `0` | all servers | `SO_SNDBUF`; `0` keeps kernel defaults. |
+| `useRecvBundle` | `false` | TCP servers | Requests recv-bundle mode when supported. |
+| `useZeroCopySend` | `false` | all servers | Requests `IORING_OP_SEND_ZC`. |
+| `useRegisteredSendBuffer` | `false` | all servers | Requests fixed-buffer send mode. |
+| `useZeroCopyReceive` | `false` | all servers | Requests ZCRX; requires capable hardware and permissions. |
+
+TCP-only queue options:
+
+| Option | Default | Purpose |
+| --- | ---: | --- |
+| `commandQueueCapacity` | `65536` | JS-to-native command queue bound. |
+| `eventQueueCapacity` | `65536` | Native-to-JS event queue bound. |
+| `eventBatchSize` | `64` | Events per JS batch in `startBatch()` and the facade. |
+| `sendQueueCapacity` | `1024` | Per-connection native send backlog. |
+| `sendBufferCount` | `256` | Fixed-send pool slot count. |
+| `sendBufferSize` | `2048` | Fixed-send pool slot size. |
+
+All servers expose live counters through `ServerInfo`, including accepted/closed/rejected connections, bytes sent/received, queue drops, receive buffer starvations, recv-bundle counters, zero-copy send counters, fixed-send misses, and ZCRX packet counters.
+
+## Performance and benchmarks
+
+The repository includes benchmark drivers, but the README does not publish benchmark numbers because results depend on kernel, CPU, NIC, limits, and benchmark shape.
+
+```bash
+npm run bench
+npm run bench:tcp
+npm run bench:high
+npm run bench:first-slice
+REQUESTS=1000 CONCURRENCY=32 npm run bench:syscalls
+```
+
+Benchmark scripts:
+
+- `benchmark/compare.js` compares Node HTTP with `UringHttpServer`.
+- `benchmark/tcp-echo.js` compares Node TCP, the ferrings TCP facade, raw TCP, native echo, recv-bundle, and zero-copy-send variants when available.
+- `benchmark/high-concurrency.js` runs HTTP and TCP cases with higher concurrency defaults.
+- `benchmark/syscalls.js` uses `strace -f -c` when installed to report server-side syscalls per completed connection.
+- `benchmark/first-slice.js` writes one compact validation report for the first useful slice across capabilities, HTTP, TCP, and syscall cases.
+
+Set `REPORT_PATH=artifacts/<name>.json` to keep machine-readable reports.
+
+## ZCRX
+
+ZCRX support is present but gated. Use it only on hosts with the right kernel, permissions, NIC support, header/data split, and flow steering/RSS isolation.
+
+```bash
+node bin/ferrings.js zcrx-probe --interface eth0 --rx-queue 0 --active --json
+ZCRX_INTERFACE=eth0 ZCRX_CONNECT_HOST=<nic-routed-host> npm run test:zcrx
+```
+
+`test:zcrx` starts the HTTP, native TCP echo, and programmable TCP servers with `useZeroCopyReceive: true`, drives traffic through `ZCRX_CONNECT_HOST`, and requires `ServerInfo.zcrxPackets` and `zcrxBytes` to increase.
+
+For a real NIC receive proof, avoid `127.0.0.1`; route packets through the selected NIC queue, usually from a second host or a network namespace.
+
+## Release and package layout
+
+The release flow follows napi-rs native package conventions:
+
+- Root package: `ferrings`
+- Optional native packages:
+  - `ferrings-linux-x64-gnu`
+  - `ferrings-linux-x64-musl`
+  - `ferrings-linux-arm64-gnu`
+  - `ferrings-linux-arm64-musl`
+
+Useful release checks:
+
+```bash
+npm run check:native-packages
+npm run check:npm-new-names
+npm run check:release-repository
+npm run check:release-ready -- --full --strict
+npm run check:release-ready -- --full --require-zcrx
+```
+
+Tag pushes that match the package version build all native artifacts, run package checks, and publish to npm with the repository `NPM_TOKEN` secret. Manual `workflow_dispatch` runs can also publish when `publish=true`.
+
+## Limitations and tradeoffs
+
+- Linux only; there is no macOS or Windows transport.
+- Node.js `>=20` is required.
+- This is a native addon, so kernel support and process limits affect which fast paths are active.
+- The TCP facade is intentionally similar to Node's server shape, but it is not a drop-in replacement for every `net.Server` behavior.
+- `UringHttpServer` is a fixed-response benchmark server, not an HTTP application framework.
+- TLS is not implemented.
+- ZCRX requires specific NIC hardware, kernel support, queue setup, permissions, and routed traffic through the selected RX queue.
+- Registered-buffer send can be unavailable even when the kernel supports other modern `io_uring` networking features; ferrings reports that through `capabilities().registeredSendBuffer`.
+- APIs and packaging are still at the 0.1 release-candidate stage.
+
+## Docs, examples, and project health
+
+- Examples: [`examples/http-fixed.js`](examples/http-fixed.js), [`examples/tcp-echo.js`](examples/tcp-echo.js)
+- Benchmarks: [`benchmark/`](benchmark/)
+- Type surface: [`index.d.ts`](index.d.ts), [`native.d.ts`](native.d.ts)
+- CLI entrypoint: [`bin/ferrings.js`](bin/ferrings.js)
+- Release workflow: [`.github/workflows/release.yml`](.github/workflows/release.yml)
+- CI workflow: [`.github/workflows/ci.yml`](.github/workflows/ci.yml)
+- Tests: [`test/`](test/)
+
+There is no separate docs site yet; the README, type definitions, examples, and tests are the current reference material.
+
+## Contributing
+
+Issues and pull requests are welcome. There is no standalone `CONTRIBUTING.md` yet, so use this baseline before opening a change:
+
+```bash
+npm install
+npm test
+npm run check:release-ready -- --full --strict
+```
+
+For changes that touch native packaging, also run:
+
+```bash
+npm run check:native-packages
+npm run check:publish
+```
+
+For ZCRX changes, include `npm run test:zcrx` output when you have access to capable hardware. If you do not, include `node bin/ferrings.js zcrx-probe --all --active --json` output so reviewers can see the blocker.
+
+## License
+
+Licensed under either of:
+
+- [MIT](LICENSE-MIT)
+- [Apache-2.0](LICENSE-APACHE)
+
+at your option.