Skip to content

Commit c5c2240

Browse files
bump the version and add README clarifications
1 parent 29feec6 commit c5c2240

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,20 +110,24 @@ npm pack
110110
## Future features
111111
Status: currently disabled/broken; will be re-enabled with proper tests.
112112

113+
* **Graceful WebRTC shutdown (remove hard-exit workaround)**
114+
Plan to replace the current hard process exit (`hard-exit.js`) with a proper, graceful shutdown of the WebRTC stack once upstream issues in the dependency are resolved/worked around. The hard-exit is a temporary measure due to known problems in `node-webrtc` (see [#35](https://github.com/WonderInventions/node-webrtc/issues/35), [#36](https://github.com/WonderInventions/node-webrtc/issues/36), [#37](https://github.com/WonderInventions/node-webrtc/issues/37)). The goal is to reliably close data channels/peer connections, tear down transports, and let the process exit cleanly without forcing it.
115+
113116
* **Custom endpoints via config file**
114117
Support a user config (e.g., `~/.config/noisytransfer/config.json`, or `%APPDATA%\NoisyTransfer\config.json` on Windows) to override network endpoints and auth:
115118

116119
```jsonc
117-
{
118-
// planned fields
119-
"relay": "wss://rvz.example.com/relay",
120-
"api": "https://rvz.example.com",
121-
"headers": { "Authorization": "Bearer …" }
122-
}
123-
```
120+
{
121+
// planned fields
122+
"relay": "wss://rvz.example.com/relay",
123+
"api": "https://rvz.example.com",
124+
"headers": { "Authorization": "Bearer …" }
125+
}
126+
````
124127

125128
The CLI will use built-in defaults when the file is absent. A matching set of env vars may be recognized too.
126129

130+
127131
* **Explicit endpoint flags (optional override)**
128132
After config lands, we may re-introduce CLI overrides like `--relay/--api/--headers` for advanced users and scripts.
129133
*(In the current release these flags are intentionally disabled.)*
@@ -134,10 +138,10 @@ Status: currently disabled/broken; will be re-enabled with proper tests.
134138
* **`--stdin-name` (re-enable)**
135139
When sending from stdin (`nt send -`), allow announcing a filename for the receiver:
136140

137-
```bash
138-
cat report.pdf | nt send - --stdin-name report.pdf
139-
# default would be "stdin.bin" if omitted
140-
```
141+
```bash
142+
cat report.pdf | nt send - --stdin-name report.pdf
143+
# default would be "stdin.bin" if omitted
144+
```
141145

142146
## License
143147

src/cli.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ program
8484
.description(
8585
"noisytransfer CLI — Fast E2EE WebRTC file transfer (DTLS by default, optional PQ via sender --pq).",
8686
)
87-
.version("0.0.0"); // bundler replaces this
87+
.version("0.2.3");
8888

8989
// Show help/suggestions after errors when supported
9090
if (typeof program.showHelpAfterError === "function") program.showHelpAfterError();

0 commit comments

Comments
 (0)