From 5c13cbb08f7b38a49f585b26f8d953b818d4e8ab Mon Sep 17 00:00:00 2001 From: Benjamin Sergeant Date: Tue, 6 Aug 2019 20:55:44 -0700 Subject: [PATCH] update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fdf52bf4..f7f76ad6 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage. -Here is what the client API looks like. +### WebSocket client API ``` ix::WebSocket webSocket; @@ -56,7 +56,7 @@ webSocket.sendBinary("some serialized binary data"); webSocket.stop() ``` -Here is what the server API looks like. Note that server support is very recent and subject to changes. +### WebSocket server API ``` // Run a server on localhost at a given port. @@ -117,7 +117,7 @@ server.wait(); ``` -Here is what the HTTP client API looks like. +### HTTP client API ``` // @@ -196,7 +196,7 @@ bool ok = httpClient.performRequest(args, [](const HttpResponsePtr& response) // ok will be false if your httpClient is not async ``` -Here is what the HTTP server API looks like. Note that HTTP server support is very, very recent and subject to changes. +### HTTP server API ``` ix::HttpServer server(port, hostname);