Skip to content

Commit 342ca0b

Browse files
Add version compatibility chart to README
1 parent aae49c2 commit 342ca0b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,32 @@ python-socketio
99

1010
Python implementation of the `Socket.IO`_ realtime client and server.
1111

12+
Version compatibility
13+
---------------------
14+
15+
The Socket.IO protocol has been through a number of revisions, and some of these
16+
introduced backward incompatible changes, which means that the client and the
17+
server must use compatible versions for everything to work.
18+
19+
If you are using the Python client and server, the easiest way to ensure compatibility
20+
is to use the same version of this package for the client and the server. If you are
21+
using this package with a different client or server, then you must ensure the
22+
versions are compatible.
23+
24+
The version compatiblity chart below maps versions of this package to versions
25+
of the JavaScript reference implementation and the versions of the Socket.IO and
26+
Engine.IO protocols.
27+
28+
+------------------------------+-----------------------------+-----------------------------+-------------------------+
29+
| JavaScript Socket.IO version | Socket.IO protocol revision | Engine.IO protocol revision | python-socketio version |
30+
+==============================+=============================+=============================+=========================+
31+
| 0.9.x | 1, 2 | 1, 2 | Not supported |
32+
+------------------------------+-----------------------------+-----------------------------+-------------------------+
33+
| 1.x and 2.x | 3, 4 | 3 | 4.x |
34+
+------------------------------+-----------------------------+-----------------------------+-------------------------+
35+
| 3.x | 5 | 4 | 5.x |
36+
+------------------------------+-----------------------------+-----------------------------+-------------------------+
37+
1238
Resources
1339
---------
1440

0 commit comments

Comments
 (0)