From d46bb83f4eb488c73a1ad03eacacd5ccaeaff7d9 Mon Sep 17 00:00:00 2001 From: Simon Oberhammer Date: Mon, 2 Jun 2014 14:54:42 +0200 Subject: [PATCH] readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 27f0a36..988afc2 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,11 @@ Topics Usage ================= +See the examples directory for working examples. + ## Standalone -HTML File: +HTML File loads GameJs and sets the main module: -"./javascript/main.js": +The main module `javascript/main.js` starts the application: var gamejs = require('gamejs'); gamejs.ready(function() { + var display = gamejs.display.getSurface(); ... }); -## GameJs a node package with browserify +## GameJs as a node package with browserify -GameJs is a CommonJs package published on NPM. To use it with [browserify](http://browserify.org/) install GameJs in your game's directory: +GameJs is a CommonJs package published on NPM. To use it with [browserify](http://browserify.org/) install the GameJs package in your game's directory: $ npm install gamejs