Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added Chilly.connect() to the documentation.

  • Loading branch information...
commit eb51fdde2109a061a6fd13a23ebe6fe4e40c0a00 1 parent 13aca2d
@TajPelc authored
Showing with 4 additions and 3 deletions.
  1. +4 −3 README.md
View
7 README.md
@@ -50,7 +50,9 @@ Start by creating an index.html file in `/public/index.html`, then run the serve
Include the Chilly Framework front end library with `<script src="/js/libraries/chilly-0.2.js" />`. Create your own JavaScript file, for example game.js and include it.
-To start Chilly Framework call `Chilly.init();`. This triggers an `init` event.
+To start Chilly Framework call `Chilly.init();`, it should be called only after the windows has loaded. This triggers an `init` event.
+
+To start listening for updates on all defined channels (add the default called update), call `Chilly.connect()`.
To bind events use:
@@ -58,7 +60,6 @@ To bind events use:
Chilly.bind('init', function(e) { ... /* load assets, sprites, sounds, etc */ });
```
-
To trigger custom events use:
```javascript
@@ -105,7 +106,7 @@ ______________________________________________
Open `actions.js` and define additional update channels with:
```javascript
-Chilly.createChannel('chat');
+Chilly.createChannel('channelName');
```
Open `actions.js` and define responses to requests send from the front end by `Chilly.request` with:
Please sign in to comment.
Something went wrong with that request. Please try again.