Skip to content

Commit f0197a4

Browse files
committed
docs: touch up README for workspace change
* Update test client.c/server.c links * Update cmake invocations to use `-S librustls` instead of `-S .` * Mention the curl vtls backend as a good external example * Fix mod_tls link * Replace a "MSRV" usage with language that will be more familiar to a non-Rust developer looking for C interop
1 parent 5003f40 commit f0197a4

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ You can optionally enable [RFC 8879](https://www.rfc-editor.org/rfc/rfc8879)
104104
certificate compression support with `--features=cert_compression`.
105105

106106
This is **disabled** by default. Enabling this feature will bring in additional
107-
dependencies (e.g. `zlib-rs`, `brotli`) and requires an MSRV of 1.75. Once
108-
enabled support is handled transparently and no code changes are required in
109-
your application.
107+
dependencies (e.g. `zlib-rs`, `brotli`) and requires a minimum Rust version of
108+
1.75+. Once enabled support is handled transparently and no code changes are
109+
required in your application.
110110

111111
```bash
112112
cargo capi install # Without cert compression.
@@ -192,8 +192,12 @@ the built library should use the exact rustls-ffi version as the dynamic library
192192

193193
The rustls-ffi repo includes two example C programs for Linux, MacOS and Windows:
194194

195-
* [tests/client.c](tests/client.c) - a simple HTTPS client
196-
* [tests/server.c](tests/server.c) - a simple HTTPS server
195+
* [tests/client.c](librustls/tests/client.c) - a simple HTTPS client
196+
* [tests/server.c](librustls/tests/server.c) - a simple HTTPS server
197+
198+
For a more realistic example of integrating rustls-ffi into a pre-existing
199+
C project see the [rustls-ffi vtls
200+
backend](https://github.com/curl/curl/blob/master/lib/vtls/rustls.c) in `curl`.
197201

198202
## Building the Examples
199203

@@ -205,7 +209,7 @@ Windows).
205209

206210
```
207211
# Configure your build directory
208-
cmake -S . -B build -DCMAKE_BUILD_TYPE=release
212+
cmake -S librustls -B build -DCMAKE_BUILD_TYPE=release
209213
210214
# Build the client/server examples
211215
cmake --build build
@@ -234,7 +238,7 @@ of `-DCMAKE_BUILD_TYPE`:
234238

235239
```
236240
# Configure your build directory
237-
cmake -S . -B build
241+
cmake -S librustls -B build
238242
239243
# Build the client/server examples
240244
cmake --build build --config Release
@@ -247,7 +251,7 @@ compression, the ring cryptography provider, and `clang` as the compiler on
247251
a Linux system in a `my-clang-build` build directory:
248252

249253
```
250-
CC=clang CXX=clang cmake -S . -B my-clang-build -DCMAKE_BUILD_TYPE=Debug -DCERT_COMPRESSION=on
254+
CC=clang CXX=clang cmake -S librustls -B my-clang-build -DCMAKE_BUILD_TYPE=Debug -DCERT_COMPRESSION=on
251255
-DCRYPTO_PROVIDER=ring
252256
cmake --build my-clang-build --target integration-test
253257
```
@@ -376,7 +380,7 @@ need further evaluation and will most likely change significantly in the future.
376380
The `rustls_server_config_builder_set_hello_callback` and its provided information
377381
in `rustls_client_hello` will change. The current design is a snapshot of the
378382
implementation efforts in
379-
[mod_tls](https://httpd.apache.org/docs/2.4/mod/mod_tls.html) to provide
383+
[mod_tls](https://github.com/icing/mod_tls) to provide
380384
`rustls`-based TLS as module for the Apache webserver.
381385

382386
For a webserver hosting multiple domains on the same endpoint, it is highly desirable

0 commit comments

Comments
 (0)