Improve awc websocket docs

[popzxc]

PR Type

Docs

PR Checklist

Check your PR fulfills the following:

• Tests for the changes have been added / updated.
• Documentation comments have been added / updated.
• A changelog entry has been made for the appropriate packages.
• Format code with the latest stable rustfmt

Overview

When I first tried to use awc, I had some problems with understanding how to use it with WebSocket.

I thought an example will be very helpful for readers.

[codecov-commenter]

Codecov Report

Merging #1654 into master will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1654      +/-   ##
==========================================
- Coverage   53.20%   53.19%   -0.01%     
==========================================
  Files         123      123              
  Lines       11832    11833       +1     
==========================================
  Hits         6295     6295              
- Misses       5537     5538       +1     

Impacted Files	Coverage Δ
awc/src/lib.rs	36.36% <ø> (ø)
awc/src/ws.rs	0.00% <ø> (ø)
actix-http/src/header/common/accept.rs	0.00% <0.00%> (ø)
actix-http/src/header/common/if_none_match.rs
actix-http/src/header/common/accept_charset.rs	0.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9a9d4b1...ba9a09b. Read the comment docs.

[popzxc]

Hm. I'm not sure why CI fails on windows, but passes on Linux / macOS. It doesn't seem that doctest has some platform-specific code.

[Neopallium]

Looks like an issue getting a cert for TLS:

"the handshake failed: error:1416F086:SSL routines:tls_process_server_certificate:certificate verify failed:ssl\statem\statem_clnt.c:1924:: unable to get local issuer certificate"

I don't think it is related to this PR.

[Neopallium]

Would it work with "ws://echo.websocket.org" ws instead of wss?

[Neopallium]

Looks good.

[robjtede]

just some wording adjustments, otherwise LGTM

[robjtede]

thanks for the contribution 👍