Adds more indeep comments to understand the example and how to use fluxmax.

hackhat · hackhat · commit 1beee185a615 · 2015-03-06T16:56:41.000Z
diff --git a/Readme.md b/Readme.md
@@ -19,6 +19,7 @@ Across the project there will be some hashtags that marks essential parts of flu
  - Start [here](./src/index.js). This is the first file loaded in the app and follow the comments from there;
  - Read about [stores](./src/stores/Readme.md);
  - Read about [views](./src/ui/Readme.md);
+ - Read about [actions](./src/Actions.js);
 
 *You don't understand something? Open an issue.*
 
@@ -64,7 +65,7 @@ Go to: [http://localhost:8080/](http://localhost:8080/) (yes, you can click on t
  - Click on a complete task to make it non complete;
  - Watch the user's points grow;
  - Watch how the tasks gets auto completed when the threshold is hit;
- - Open up the console and check how exactly the app communicates internally;
+ - Open up the console, refresh and check how exactly the app communicates internally;
 
 
 
diff --git a/src/stores/Readme.md b/src/stores/Readme.md
@@ -19,3 +19,5 @@ Here we create stores that inherit from the BaseStore. In this example we have 2
 
  - [TaskStore](./TaskStore.js);
  - [UserStore](./UserStore.js);
+
+Now proceed to read the UI. Go to [UI](../ui/Readme.md).
diff --git a/src/stores/TaskStore.js b/src/stores/TaskStore.js
@@ -21,7 +21,8 @@ var TaskStore = function(options){
     // #fluxmax-tag
     // You really need to set the store's class in the instance
     // in this variable. This is needed by the fluxmax system to
-    // setup all the wiring of your app.
+    // setup all the wiring of your app. Notice that is not the instance,
+    // is the Class.
     this.Class = TaskStore;
     this.__tasks = [];
     this.__taskId = 0;
@@ -36,7 +37,7 @@ var TaskStore = function(options){
 // #fluxmax-tag
 // Here is another essential part of your store. This describes your store's
 // entity, such as it's name, which events dispatches and to which events it
-// listens to. Read the comments below:
+// listens to. We call it entity's metadata. Read the comments below:
 var E = TaskStore; // "E" from "Entity".
 E.meta = {
     // Unique id of this entity. Is a good practice to name stores with the `store.`
@@ -45,6 +46,8 @@ E.meta = {
     id: 'store.task',
     // What events this entity dispatches. These are the events that your store emits
     // to the app. Other views and stores might listen to them.
+    // You can even document the data it passes. Later this data will use a schema to be checked
+    // against.
     changeTypes: [
         'added',
         'completed',
@@ -175,3 +178,4 @@ _.extend(TaskStore.prototype, BaseStore.prototype, {
 
 
 module.exports = TaskStore;
+// Now go back to the ./src/stores/Readme.md to continue the read.
diff --git a/src/stores/UserStore.js b/src/stores/UserStore.js
@@ -92,3 +92,4 @@ _.extend(UserStore.prototype, BaseStore.prototype, {
 
 
 module.exports = UserStore;
+// Now go back to the ./src/stores/Readme.md to continue the read.
diff --git a/src/ui/Readme.md b/src/ui/Readme.md
@@ -5,3 +5,5 @@ This folder tree contains all the user interface of the app. Uses react.js to re
 Go on and open the [Tasks view](./Tasks.js) and the open the [Root view](./Root.js).
 
 When you are done you might take a look at the [Task view](./Task.js)(This is the item renderer used by the Tasks view, don't confuse them!).
+
+No go to read about [actions](../Actions.js);

Original file line number	Diff line number	Diff line change
`@@ -92,3 +92,4 @@ _.extend(UserStore.prototype, BaseStore.prototype, {`
`92`	`92`
`93`	`93`
`94`	`94`	`module.exports = UserStore;`
	`95`	`+// Now go back to the ./src/stores/Readme.md to continue the read.`