Skip to content

Commit 204fd6a

Browse files
committed
Do some last README tidy up
1 parent 349b90b commit 204fd6a

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If parsing fails, this method will throw an error, but will still ensure all dat
4242

4343
The returned promise resolves to a `TlsClientHelloMessage` object containing:
4444

45-
* `version` - The legacy version field (e.g. `0x0303` for TLS 1.2/1.3)
45+
* `version` - The ClientHello version field (`0x0303` for TLS 1.2 and 1.3 — for TLS 1.3+, check the `supported_versions` extension for the real negotiated version)
4646
* `random` - 32-byte client random as a Buffer
4747
* `sessionId` - Session ID as a Buffer (0–32 bytes, empty Buffer if absent)
4848
* `cipherSuites` - All cipher suite IDs as a number array, **including** GREASE values
@@ -73,10 +73,10 @@ To calculate TLS fingerprints, there are a few options exported from this module
7373

7474
Use `getExtensionData(extensions, id)` to look up a specific extension's parsed data by numeric ID, name, or alias. Returns the data object, or `null` if the extension is not present.
7575

76-
Names should be the officially registered name from https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml. Convenient aliases are provided for common cases, including `sni`, `alpn`, `alps` and `ech`. The API is typed so with TypeScript only valid names are allowed (although any raw numeric id can be used). PRs to add more aliases are welcome.
76+
Names should be the officially registered name from https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml. Convenient aliases are provided for common cases, including `sni`, `alpn`, `alps` and `ech`. The API is typed so that with TypeScript only valid names are allowed (although any raw numeric ID can be used). PRs to add more aliases are welcome.
7777

7878
```javascript
79-
const { readTlsClientHello, getExtensionData, EXTENSION_IDS } = require('read-tls-client-hello');
79+
const { readTlsClientHello, getExtensionData } = require('read-tls-client-hello');
8080

8181
const clientHello = await readTlsClientHello(socket);
8282

0 commit comments

Comments
 (0)