Steev/JS-Server-Framework
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
steevLP 2022-03-19 19:49:27 +01:00 committed by GitHub
parent 116bd5bc2c
commit bb33d3ecc4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
readme.md
View File

@ -1,10 +1,10 @@
# What does this Framework aim? # What does this Framework aim?
Simply dealing with as the description says "nearly" all kind of software which means it deals with a few much used socket protocols Simply dealing with as the description says "nearly" all kinds 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 Since it also handles web socket requests it can be used as a real cross-side server
# Documentation # Documentation
You do not really need much to get your Server Running! You do not need much to get your Server Running!
Basicly all you need, is the Packet Structur and the the know how, how to create events. All you need is the Packet Structure and the know-how of how to create events.
## Packets ## Packets
That's easy, look! That's easy, look!
@ -24,15 +24,15 @@ and this can go on for ever but, this should show the point of a packet
## Events ## Events
Something needs to happen with your packet! The Event Handler is handling it. Something needs to happen with your packet! The Event Handler is handling it.
The Handler is taking in a **Event Name** and a **Function** for it. The Handler is taking in an **Event Name** and a **Function** for it.
Events look like this: Events look like this:
``` ```
{name:'logout', function() {eventFunction(possible,arguments)}}, {name:'logout', function() {eventFunction(possible,arguments)}},
``` ```
But somewhere your event need to be defined! But somewhere your event needs to be defined!
As Default they are stored in *bin/classes/events* As default they are stored in *bin/classes/events*
and a normal Event is build like this: and a normal Event is build like this:
```js ```js
@ -40,5 +40,5 @@ event_function(){
Console.log('Your code here please'); Console.log('Your code here please');
} }
``` ```
Not really difficult right? Not difficult right?
well then good luck and happy coding with it :D well, then good luck and happy coding :D