Normalizes API for entities

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index ef2214ea6b35ac26a41e86e3cec2a89217bee918..6724652ea0d47572cda501d06aac6e9cb14ee167 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Serpentity
 
 # Serpentity
 

-Serpentity is a simple entity framework inspired by Ash.
+Serpentity is a simple entity framework inspired by [Ash][ash].

 
 Usage:
 
 
 Usage:
 


@@ -10,10 +10,11 @@ Usage:
 
     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.addEntity(entityFactory());

-    engine.addSystem(new GameSystem());
+    engine.addSystem(new GameSystem(), priority);

 
 Update all systems:
 
 
 Update all systems:
 


@@ -44,9 +45,9 @@ eventually be consumed by "Systems"
         }
     });
 
         }
     });
 

-You can add components to entities by using the add method:
+You can add components to entities by using the addComponent method:

 
 

-    entity.add(new PositionComponent());
+    entity.addComponent(new PositionComponent());

 
 
 Systems can refer to entities by requesting nodes.
 
 
 Systems can refer to entities by requesting nodes.


@@ -92,8 +93,17 @@ Systems are called on every update, and they use components through nodes.
 
 Just run `engine.update(dt)` in your game loop :D
 
 
 Just run `engine.update(dt)` in your game loop :D
 

+## Checking it in the frontend (dev).
+
+You can link the bower package to test it out locally.
+Spawn a python server (`python -m SimpleHTTPServer`) to see
+the test page in `http://localhost:8000/browser_test/`
+
+

 ## TO-DO
 
 * Removing components
 * Implement the ashteroids demo (Serpentoids)
 * Actually check performance
 ## TO-DO
 
 * Removing components
 * Implement the ashteroids demo (Serpentoids)
 * Actually check performance

+
+[ash]: http://www.ashframework.org/