Adds license and gitignore

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 3878dd15a67c219c103888b220f2390d97c03c8e..3d2ebb0775533f283aef27c447f7a3c7f42e3049 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
-Serpentity is a simple entity framework inspired by Ash.
+# Serpentity
+
+Serpentity is a simple entity framework inspired by [Ash][ash].
 
 Usage:
 
-require('serpentity');
+    require('serpentity');
 
 ## Instantiating an engine
 
-var engine = Serpentity();
+    var engine = Serpentity();
 
-Add entities or systems:
+Add entities or systems, systems are added with a priority (the smaller
+the number, the earlier it will be called):
 
     engine.addEntity(entityFactory());
-    engine.addSystem(new GameSystem());
+    engine.addSystem(new GameSystem(), priority);
 
 Update all systems:
 
@@ -26,7 +29,7 @@ Remove entities or systems:
 
 Entities are the basic object of Serpentity, and they do nothing.
 
-    var entity = new Serpentity.entity();
+    var entity = new Serpentity.Entity();
 
 All the behavior is added through components
 
@@ -70,21 +73,21 @@ that comply with that API
 
 Systems are called on every update, and they use components through nodes.
 
-Class("TestSystem").inherits(Serpentity.System)({
-    prototype : {
-        added : function added(engine){
-            this.nodeList = engine.getNodes(MovementNode);
-        },
-        removed : function removed(engine){
-            this.nodeList = undefined;
-        }
-        update : function update(dt){
-            this.nodeList.forEach(function (node) {
-                console.log("Current position is: " + node.position.x + "," + node.position.y);
-            });
+    Class("TestSystem").inherits(Serpentity.System)({
+        prototype : {
+            added : function added(engine){
+                this.nodeList = engine.getNodes(MovementNode);
+            },
+            removed : function removed(engine){
+                this.nodeList = undefined;
+            }
+            update : function update(dt){
+                this.nodeList.forEach(function (node) {
+                    console.log("Current position is: " + node.position.x + "," + node.position.y);
+                });
+            }
         }
-    }
-});
+    });
 
 ## That's it
 
@@ -95,3 +98,5 @@ Just run `engine.update(dt)` in your game loop :D
 * Removing components
 * Implement the ashteroids demo (Serpentoids)
 * Actually check performance
+
+[ash]: http://www.ashframework.org/