From 342ca0bb9da8b9ea6c63aa3bd05a37903416d301 Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Sat, 5 Dec 2020 19:19:04 +0000 Subject: [PATCH] Add version compatibility chart to README --- README.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.rst b/README.rst index c1d462b..cc052e3 100644 --- a/README.rst +++ b/README.rst @@ -9,6 +9,32 @@ python-socketio Python implementation of the `Socket.IO`_ realtime client and server. +Version compatibility +--------------------- + +The Socket.IO protocol has been through a number of revisions, and some of these +introduced backward incompatible changes, which means that the client and the +server must use compatible versions for everything to work. + +If you are using the Python client and server, the easiest way to ensure compatibility +is to use the same version of this package for the client and the server. If you are +using this package with a different client or server, then you must ensure the +versions are compatible. + +The version compatiblity chart below maps versions of this package to versions +of the JavaScript reference implementation and the versions of the Socket.IO and +Engine.IO protocols. + ++------------------------------+-----------------------------+-----------------------------+-------------------------+ +| JavaScript Socket.IO version | Socket.IO protocol revision | Engine.IO protocol revision | python-socketio version | ++==============================+=============================+=============================+=========================+ +| 0.9.x | 1, 2 | 1, 2 | Not supported | ++------------------------------+-----------------------------+-----------------------------+-------------------------+ +| 1.x and 2.x | 3, 4 | 3 | 4.x | ++------------------------------+-----------------------------+-----------------------------+-------------------------+ +| 3.x | 5 | 4 | 5.x | ++------------------------------+-----------------------------+-----------------------------+-------------------------+ + Resources ---------