Merge branch 'hotfix/2.1.0'

[rbdr/serpentity] / README.md

diff --git a/README.md b/README.md
index 4d73f182208efc8b870f5cb21f366c535891cf72..50b8f868e182d2eea4911750ada2327d6b5ee342 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,11 +4,11 @@ Serpentity is a simple entity framework inspired by [Ash][ash].
 
 Usage:
 
-    require('serpentity');
+    const Serpentity = require('serpentity');
 
 ## Instantiating an engine
 
-    var engine = Serpentity();
+    const engine = new Serpentity();
 
 Add entities or systems, systems are added with a priority (the smaller
 the number, the earlier it will be called):
@@ -29,7 +29,7 @@ Remove entities or systems:
 
 Entities are the basic object of Serpentity, and they do nothing.
 
-    var entity = new Serpentity.Entity();
+    const entity = new Serpentity.Entity();
 
 All the behavior is added through components
 
@@ -38,16 +38,19 @@ All the behavior is added through components
 Components define data that we can add to an entity. This data will
 eventually be consumed by "Systems"
 
-    Class("PositionComponent").inherits(Serpentity.Component)({
-        prototype : {
-            x : 0,
-            y : 0
-        }
-    });
+    const PositionComponent = class PositionComponent extends Serpentity.Component {
+      constructor(config) {
+
+        this.x = 0;
+        this.y = 0;
+
+        super(config);
+      }
+    };
 
 You can add components to entities by using the add method:
 
-    entity.add(new PositionComponent());
+    entity.addComponent(new PositionComponent());
 
 
 Systems can refer to entities by requesting nodes.
@@ -57,12 +60,9 @@ Systems can refer to entities by requesting nodes.
 Nodes are sets of components that you define, so your system can require
 entities that always follow the API defined in the node.
 
-    Class("MovementNode").inherits(Serpentity.Node)({
-        types : {
-            position : PositionComponent,
-            motion : MotionComponent
-        }
-    });
+    const MovementNode = class MovementNode extends Serpentity.Node;
+    MovementNode.position = PositionComponent;
+    MovementNode.motion = MotionComponent;
 
 You can then request an array of all the nodes representing entities
 that comply with that API
@@ -73,40 +73,30 @@ that comply with that API
 
 Systems are called on every update, and they use components through nodes.
 
-    Class("TestSystem").inherits(Serpentity.System)({
-        prototype : {
-            added : function added(engine){
-                this.nodeList = engine.getNodes(MovementNode);
-            },
-            removed : function removed(engine){
-                this.nodeList = undefined;
-            }
-            update : function update(dt){
-                this.nodeList.forEach(function (node) {
-                    console.log("Current position is: " + node.position.x + "," + node.position.y);
-                });
-            }
-        }
-    });
+    const TestSystem = class TestSystem extends Serpentity.System {
+      added(engine){
 
-## That's it
+        this.nodeList = engine.getNodes(MovementNode);
+      }
 
-Just run `engine.update(dt)` in your game loop :D
+      removed(engine){
 
-## Checking it in the frontend (dev).
+        this.nodeList = undefined;
+      }
 
-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/`
+      update(dt){
 
-If you just want to use it, it's available as a bower package!
+        for (const node of this.nodeList) {
+          console.log(`Current position is: ${node.position.x},${node.position.y}`);
+        }
+      }
+    };
 
+## That's it
 
-## TO-DO
+Just run `engine.update(dt)` in your game loop :D
 
-* Removing components
-* Implement the ashteroids demo (Serpentoids)
-* Actually check performance
+![Travis CI Build Status][travis-ci-badge]
 
 [ash]: http://www.ashframework.org/
+[travis-ci-badge]: https://travis-ci.org/serpentity/serpentity.svg?branch=master