Skip to content

Commit bdda9e0

Browse files
committed
Documentation update
1 parent 0483409 commit bdda9e0

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Please refer to the [tutorial](doc/Tutorial.md) for more examples.
246246
- Write directly to the outgoing DataWriter when data is required.
247247
- Just provide a C++ object and let the library serialize it directly to the wire.
248248
- HTTP Proxy support
249-
- SOCKS5 Proxy support (naive implementatin for now, no support for authentication).
249+
- HTTPS Proxy (using CONNECT method), SOCKS5 Proxy support (naive implementatin for now, no support for authentication).
250250

251251
# Current Status
252252
The project has been in public BETA since April 11th 2017.
@@ -262,7 +262,7 @@ These are the operating systems where my Continues Integration (Jenkins) servers
262262
- Ubuntu Xenial (LTS)
263263
- Ubuntu Bionic (LTS)
264264

265-
Support for MacOS has been removed after Apples announcement that their love for privacy was just
265+
Support for MacOS has been removed after Apples announcement that their love for privacy was just
266266
a marketing gimmick.
267267

268268
Fedora is currently disabled in my CI because of failures to start their Docker containers. (Work in progress). Ubuntu Jammy don't work in docker with my Jenkins CI pipeline, so I have no reliable way to test it. Windows 11 cannot be run on my KVM /QEMU system, because it don't support "secure" boot, so I have no way to test it.

doc/Tutorial.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,10 +288,12 @@ use the *RequestBuilder*'s *Argument()* method for this.
288288
289289
```
290290

291-
## Send a request going trough a HTTP Proxy
291+
## Send a request going trough a HTTP or HTTPS Proxy
292292
```C++
293293
// Add the proxy information to the properties used by the client
294294
Request::Properties properties;
295+
// Use proxy type Request::Proxy::Type::HTTP for simple HTTP proxing,
296+
// Request::Proxy::Type::HTTPS for HTTPS proxing over CONNECT method
295297
properties.proxy.type = Request::Proxy::Type::HTTP;
296298
properties.proxy.address = "http://127.0.0.1:3003";
297299

@@ -313,7 +315,7 @@ use the *RequestBuilder*'s *Argument()* method for this.
313315
}).get();
314316
```
315317
316-
## Use an existing thread in stead of a new worker thread
318+
## Use an existing thread instead of a new worker thread
317319
318320
This example is slightly more advanced. Here we take
319321
responsibility to run the io-service used internally by

0 commit comments

Comments
 (0)