Skip to content

Commit 367715c

Browse files
committed
link to uploaded report in new conformance section in readme
1 parent 916326d commit 367715c

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,22 @@ WebSocket support for Mint 🌱
55
> This repo is not complete: it only tests WebSockets over HTTP/1.
66
> Issues and PRs are welcome :slightly_smiling_face:
77
8+
## Spec conformance
9+
10+
This library aims to follow [RFC6455](https://tools.ietf.org/html/rfc6455)
11+
as closely as possible and uses
12+
[Autobahn|Testsuite](https://github.com/crossbario/autobahn-testsuite)
13+
to check conformance with every run of tests/CI. The auto-generated report
14+
produced by the Autobahn|Testsuite is uploaded on each push to main.
15+
16+
See the report here:
17+
https://mint-websocket.nyc3.digitaloceanspaces.com/autobahn/index.html
18+
819
## Usage
920

1021
`Mint.WebSocket` piggybacks much of the existing `Mint.HTTP` API. For example,
11-
here's sending and receiving a text frame of "hello world" to a WebSocket
12-
server which echos our frames:
22+
this snippet shows sending and receiving a text frame of "hello world" to a
23+
WebSocket server which echos our frames:
1324

1425
```elixir
1526
# bootstrap

0 commit comments

Comments
 (0)