Skip to content

Commit 150f2a0

Browse files
committed
Update marketing pitch.
1 parent 11cbe72 commit 150f2a0

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

README.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,10 @@
2525
What is ``websockets``?
2626
-----------------------
2727

28-
``websockets`` is a library for building WebSocket servers_ and clients_ in
29-
Python with a focus on correctness and simplicity.
28+
websockets is a library for building WebSocket_ servers and clients in Python
29+
with a focus on correctness, simplicity, robustness, and performance.
3030

31-
.. _servers: https://github.com/aaugustin/websockets/blob/main/example/server.py
32-
.. _clients: https://github.com/aaugustin/websockets/blob/main/example/client.py
31+
.. _WebSocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
3332

3433
Built on top of ``asyncio``, Python's standard asynchronous I/O framework, it
3534
provides an elegant coroutine-based API.
@@ -92,19 +91,19 @@ Why should I use ``websockets``?
9291

9392
The development of ``websockets`` is shaped by four principles:
9493

95-
1. **Simplicity**: all you need to understand is ``msg = await ws.recv()`` and
96-
``await ws.send(msg)``; ``websockets`` takes care of managing connections
94+
1. **Correctness**: ``websockets`` is heavily tested for compliance
95+
with :rfc:`6455`. Continuous integration fails under 100% branch
96+
coverage.
97+
98+
2. **Simplicity**: all you need to understand is ``msg = await ws.recv()`` and
99+
``await ws.send(msg)``. ``websockets`` takes care of managing connections
97100
so you can focus on your application.
98101

99-
2. **Robustness**: ``websockets`` is built for production; for example it was
102+
3. **Robustness**: ``websockets`` is built for production. For example, it was
100103
the only library to `handle backpressure correctly`_ before the issue
101104
became widely known in the Python community.
102105

103-
3. **Quality**: ``websockets`` is heavily tested. Continuous integration fails
104-
under 100% branch coverage. Also it passes the industry-standard `Autobahn
105-
Testsuite`_.
106-
107-
4. **Performance**: memory usage is configurable. An extension written in C
106+
4. **Performance**: memory usage is optimized and configurable. A C extension
108107
accelerates expensive operations. It's pre-compiled for Linux, macOS and
109108
Windows and packaged in the wheel format for each system and Python version.
110109

docs/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ websockets
2121
.. |docs| image:: https://img.shields.io/readthedocs/websockets.svg
2222
:target: https://websockets.readthedocs.io/
2323

24-
websockets is a library for building WebSocket servers_ and clients_ in Python
25-
with a focus on correctness and simplicity.
24+
websockets is a library for building WebSocket_ servers and
25+
clients in Python with a focus on correctness, simplicity, robustness, and
26+
performance.
2627

27-
.. _servers: https://github.com/aaugustin/websockets/blob/main/example/server.py
28-
.. _clients: https://github.com/aaugustin/websockets/blob/main/example/client.py
28+
.. _WebSocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
2929

3030
Built on top of :mod:`asyncio`, Python's standard asynchronous I/O framework,
3131
it provides an elegant coroutine-based API.

0 commit comments

Comments
 (0)