Skip to content

Commit

Permalink
Add version compatibility chart to README
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgrinberg committed Dec 5, 2020
1 parent aae49c2 commit 342ca0b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------

Expand Down

0 comments on commit 342ca0b

Please sign in to comment.