Normalizes API for entities

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 3d2ebb0775533f283aef27c447f7a3c7f42e3049..6724652ea0d47572cda501d06aac6e9cb14ee167 100644 (file)
--- a/README.md
+++ b/README.md
@@ -45,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.


@@ -93,6 +93,13 @@ 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
 ## TO-DO
 
 * Removing components