Skip to content

Commit

Permalink
docs: add compatibility table
Browse files Browse the repository at this point in the history
  • Loading branch information
darrachequesne committed Nov 5, 2020
1 parent e339323 commit c044433
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@
[![Build Status](https://secure.travis-ci.org/socketio/socket.io-parser.svg?branch=master)](http://travis-ci.org/socketio/socket.io-parser)
[![NPM version](https://badge.fury.io/js/socket.io-parser.svg)](http://badge.fury.io/js/socket.io-parser)

A socket.io encoder and decoder written in JavaScript complying with version `4`
A socket.io encoder and decoder written in JavaScript complying with version `5`
of [socket.io-protocol](https://github.com/socketio/socket.io-protocol).
Used by [socket.io](https://github.com/automattic/socket.io) and
[socket.io-client](https://github.com/automattic/socket.io-client).

Compatibility table:

| Parser version | Socket.IO server version | Protocol revision |
|----------------| ------------------------ | ----------------- |
| 3.x | 1.x / 2.x | 4 |
| 4.x | 3.x | 5 |


## Parser API

socket.io-parser is the reference implementation of socket.io-protocol. Read
Expand Down

0 comments on commit c044433

Please sign in to comment.