Documentation for Socket.io?

Question

I'm trying to make a real time canvas kinda thing with simply Node and Socket.io, but I'm having considerable trouble.

I don't know what anything means!

Socket.emit? Socket.on? Socket.whatever?!

Essentially, I'm coding it completely blind without any idea what in the heck I'm doing. Do you guys know where some good documentation of socket.io is?

Thanks for your answer.

Answer 1

Take a look at the wiki: https://github.com/learnboost/socket.io/wiki. It links to a decent number of support material for Socket.IO.

Here is a decent tutorial: http://howtonode.org/websockets-socketio

Answer 2

You may want to look at the documentation for node itself to understand the details of the methods you listed in your question (i.e. .on and .emit). It is my understanding that socket.io is based on node. So, take a look at the Events documentation page at nodejs.org. In my opinion, though the documentation at nodejs.org and at socket.io could use a good deal of help from a professional technical writer. The problem is that the creators of it don't have time to write documentation--they are creating useful code for the community. Excellent documentation is one way that a language, framework, library, etc. can proliferate very quickly through a community. It's what helps develop a literacy within the community.