diff --git a/README.rst b/README.rst index 16147c20..2b992a05 100644 --- a/README.rst +++ b/README.rst @@ -12,15 +12,19 @@ .. image:: https://img.shields.io/badge/Linux-yes-success?logo=linux :alt: Linux supported + :target: https://telnetlib3.readthedocs.io/ .. image:: https://img.shields.io/badge/Windows-yes-success?logo=windows :alt: Windows supported + :target: https://telnetlib3.readthedocs.io/ .. image:: https://img.shields.io/badge/MacOS-yes-success?logo=apple :alt: MacOS supported + :target: https://telnetlib3.readthedocs.io/ .. image:: https://img.shields.io/badge/BSD-yes-success?logo=freebsd :alt: BSD supported + :target: https://telnetlib3.readthedocs.io/ Introduction ============ @@ -49,9 +53,11 @@ telnetlib3 provides multiple interfaces for working with the Telnet protocol: **Blocking API** A synchronous interface modeled after telnetlib (client) and miniboa_ (server), - with enhancements. See the `sync API documentation`_. + with enhancements. - Enhancements over standard telnetlib: + See `sync API documentation`_. + + Enhancements over Python 3.11 telnetlib (client): - Full RFC 854 protocol negotiation (NAWS, TTYPE, BINARY, ECHO, SGA) - `wait_for()`_ method to block until specific option states are negotiated @@ -59,7 +65,7 @@ telnetlib3 provides multiple interfaces for working with the Telnet protocol: - Context manager support (``with TelnetConnection(...) as conn:``) - Thread-safe operation with asyncio_ running in background - Enhancements over miniboa for server-side: + Enhancements over miniboa (server): - Thread-per-connection model with blocking I/O (vs poll-based) - `readline()`_ and `read_until()`_ blocking methods