diff --git a/readme.md b/readme.md index 8a1392b..8e717ee 100644 --- a/readme.md +++ b/readme.md @@ -2,4 +2,43 @@ Simply dealing with as the description says "nearly" all kind of software which means it deals with a few much used socket protocols Since it also handles web socket request it can be used as real coss side server -# Documentation may folow later +# Documentation +You do not realy need much to get your Server Running +basicly all you need is the Packet Structur and the the know how, how to create events. + +## Packets +thats easy look! +Packets are platform and socket wide the same + +A Normal Packet would look like this +```json +{"event":"name", "payload":"your_data"} +``` +But you can parse even more Objects inside the Packet +```json +{"event":"name", "payload":{"arg1":"arg_value_1","arg2":"arg_value_2","arg3":"arg_value_3"}}); + +``` +and this can go on for ever but, this should show the point of a packet + + +## Events +Something need to happen with your packet and the Event Handler is handling it +The Handler is taking in a **Event Name** and a **Function** for it + +so it should look like this: +``` +{name:'logout', function() {eventFunction(possible,arguments)}}, +``` + +but somewhere your event need to be defined +as default they are stored in *bin/classes/events* + +and a normal event is build like this +```js +event_funcition(){ + Console.log('Your code here please'); +} +``` +Not realy difficult right? +well then good luck and happy coding with it :D