Normalizes API for entities

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 4d73f182208efc8b870f5cb21f366c535891cf72..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.


@@ -95,12 +95,9 @@ Just run `engine.update(dt)` in your game loop :D
 
 ## Checking it in the frontend (dev).
 
 
 ## Checking it in the frontend (dev).
 

-You can link the bower package (bower.json is in `lib/serpentity/` to
-make paths cleaner), then link it again from the root directory and
-spawn a python server (`python -m SimpleHTTPServer`). The test page
-will be available in `http://localhost:8000/browser_test/`
-
-If you just want to use it, it's available as a bower package!
+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
 
 
 ## TO-DO