Skip to content

Commit 32ae22b

Browse files
authored
readme: document encryption features
1 parent 7243d60 commit 32ae22b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,12 @@ The full API documentation is available here on [pkg.go.dev](https://pkg.go.dev/
155155
* Chat & console messages <sup id="achat1">1</sup> - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#ChatMessage) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
156156
* Matchmaking ranks (official MM demos only) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#RankUpdate)
157157
* Full POV demo support <sup id="achat1">2</sup>
158+
* Support for encrypted net-messages (if the decryption key is provided via [`ParserConfig.NetMessageDecryptionKey`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#ParserConfig))
158159
* JavaScript (browser / Node.js) support via WebAssembly - [example](https://github.com/markus-wa/demoinfocs-wasm)
159160
* [Easy debugging via build-flags](#debugging)
160161
* Built with performance & concurrency in mind
161162

162-
1. <small id="f1">Only for some demos; in MM demos the chat is encrypted for example.</small>
163+
1. <small id="f1">In MM demos the chat is encrypted, see [`ParserConfig.NetMessageDecryptionKey`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#ParserConfig) and [`MatchInfoDecryptionKey()`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#MatchInfoDecryptionKey).</small>
163164
2. <small id="f2">Better than some other parsers at the time of writing.</small>
164165

165166
## Performance / Benchmarks

0 commit comments

Comments
 (0)