summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorengn33r <engn33r@users.noreply.github.com>2021-02-24 23:18:10 -0500
committerengn33r <engn33r@users.noreply.github.com>2021-02-24 23:18:10 -0500
commitaa561086a4342c962fa5d4333f66b85c728c3624 (patch)
tree04b826038aefe6454f94d263a890819db8896d33 /README.md
parente39e64886d740eab92bfecb9351bb5d7e800a88b (diff)
downloadwebsocket-client-codecov-ci-dev.tar.gz
Update contribution guidelinescodecov-ci-dev
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index a8efe12..303ad29 100644
--- a/README.md
+++ b/README.md
@@ -6,14 +6,10 @@
# websocket-client
-The websocket-client module is a WebSocket client for Python. It provides access
-to low level APIs for WebSockets. All APIs are for synchronous functions.
-
-websocket-client supports only [hybi-13](https://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-13).
-
-## License
-
-- LGPL version 2.1
+websocket-client is a WebSocket client for Python. It provides access
+to low level APIs for WebSockets. websocket-client implements version
+[hybi-13](https://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-13)
+of the WebSocket procotol.
## Documentation
@@ -22,8 +18,7 @@ This project's documentation can be found at
## Contributing
-Please see the contribution guidelines at
-[https://websocket-client.readthedocs.io/en/latest/contributing.html](https://websocket-client.readthedocs.io/en/latest/contributing.html)
+Please see the [contribution guidelines](https://github.com/websocket-client/websocket-client/blob/master/CONTRIBUTING.md)
## Installation
@@ -43,6 +38,10 @@ support was first introduced in version 0.14.0, but is a work in progress.
Check out the documentation's FAQ for additional guidelines:
[https://websocket-client.readthedocs.io/en/latest/faq.html](https://websocket-client.readthedocs.io/en/latest/faq.html)
+## License
+
+- LGPL version 2.1
+
### Performance
The `send` and `validate_utf8` methods are very slow in pure Python. You can