Adds priorities

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 434196aea06d7faed12afe3438198cae6cdf8067..3d2ebb0775533f283aef27c447f7a3c7f42e3049 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:
 
@@ -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/