kapitan/IXWebSocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Meta: documentation fixes (#127)

Browse Source 
* Clarify versions, minor punctuation fix

* Copyediting, borked URL

* Fix Python comments in C++ code

* Copyediting

* Pretty code

* Copyediting, pretty code

* Typo

* Pretty code
This commit is contained in:
Olivia Zoe
2019-12-03 18:28:18 +01:00
committed by Benjamin Sergeant
parent c91a0d2a35
commit 2e1657167f
7 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.md
View File

@ -13,11 +13,11 @@
## Example code
```
# Required on Windows
```cpp
// Required on Windows
ix::initNetSystem();
# Our websocket object
// Our websocket object
ix::WebSocket webSocket;
std::string url("ws://localhost:8080/");
@ -40,7 +40,7 @@ webSocket.start();
webSocket.send("hello world");
```
## Why another library ?
## Why another library?
There are 2 main reasons that explain why IXWebSocket got written. First, we needed a C++ cross-platform client library, which should have few dependencies. What looked like the most solid one, [websocketpp](https://github.com/zaphoyd/websocketpp) did depend on boost and this was not an option for us. Secondly, there were other available libraries with fewer dependencies (C ones), but they required calling an explicit poll routine periodically to know if a client had received data from a server, which was not elegant.
@ -48,4 +48,4 @@ We started by solving those 2 problems, then we added server websocket code, the
## Contributing
IXWebSocket is developed on [github](https://github.com/machinezone/IXWebSocket). We'd love to hear about how you use it ; opening up an issue in github is ok for that. If things don't work as expected, please create an issue in github, or even better a pull request if you know how to fix your problem.
IXWebSocket is developed on [GitHub](https://github.com/machinezone/IXWebSocket). We'd love to hear about how you use it; opening up an issue on GitHub is ok for that. If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.