Prepares for bower

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 174c5db658f382d7497820a67a13e0622ab8f69b..4d73f182208efc8b870f5cb21f366c535891cf72 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-Serpentity is a simple entity framework inspired by Ash.
+# Serpentity
+
+Serpentity is a simple entity framework inspired by [Ash][ash].
 
 Usage:
 
@@ -8,10 +10,11 @@ Usage:
 
     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
 
@@ -90,8 +93,20 @@ Systems are called on every update, and they use components through nodes.
 
 Just run `engine.update(dt)` in your game loop :D
 
+## 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!
+
+
 ## TO-DO
 
 * Removing components
 * Implement the ashteroids demo (Serpentoids)
 * Actually check performance
+
+[ash]: http://www.ashframework.org/