adding docs

README.md

@@ -1 +1,50 @@
-# Upbeat is a high performance healthcheck/dashboard based in node
+# Upbeat 
+
+Upbeat is a high performance node-based healthcheck/dashboard.  Upbeat allows you to run health checks and provides a dashboard to chart the performance.  It also allows you to proxy and cache these health checks so they don't tax your system.  You can now reduces the number of health checks to a service from O(N) to O(1).
+
+## Installation
+
+As executable
+```bash
+npm install -g upbeat
+```
+
+Run upbeat
+```bash
+upbeat config.yml
+```
+
+As library
+```bash
+npm install upbeat
+```
+
+```js
+var upbeat = require('upbeat');
+var server = new upbeat.Server(configObject);
+server.run();
+```
+
+## Configuration
+
+Quickstart config:
+
+```yaml
+dashboard:
+  port: 2468
+
+sync:
+  redis: 
+    port: 6379
+    host: localhost
+
+services:
+  google:
+    www:
+      strategy: http
+      url: https://www.google.com
+    connection:
+      strategy: tcp
+      host: google.com
+      port: 80
+```

lib/server.ms

@@ -26,20 +26,16 @@ export class Server {
   }
 
   function sync(redis, time) {
-    if (this.syncConfig.sensors) {
-      for (var serviceName in this.services) {
-        var service = this.services[serviceName];
-        for (var sensorName in service.sensors) {
-          var sensor = service.sensors[sensorName];
-          sensor.sync(time, redis, "upbeat:services:" + serviceName + ":" + sensorName);
-        }
+    for (var serviceName in this.services) {
+      var service = this.services[serviceName];
+      for (var sensorName in service.sensors) {
+        var sensor = service.sensors[sensorName];
+        sensor.sync(time, redis, "upbeat:services:" + serviceName + ":" + sensorName);
       }
     }
 
-    if (this.syncConfig.stats) {
-      for (var k in this.stats) {
-        this.stats[k].syncTime(time, redis, k);
-      }
+    for (var k in this.stats) {
+      this.stats[k].syncTime(time, redis, k);
     }
   }
 

lib/strategies/http.ms

@@ -20,7 +20,7 @@ module.exports = #(options) {
       var data = "";
 
       res.on('data', #(chunk) { data += chunk.toString(); });
-      res.on('end', #{ cb(code != 200, data) });
+      res.on('end', #{ cb(parseInt(code) >= 400, data) });
       res.on('close', #(err) { cb(err) });
     });
 

mock/example.yml

@@ -1,4 +1,12 @@
 services:
+  google:
+    www:
+      strategy: http
+      url: https://www.google.com
+    connection:
+      strategy: tcp
+      host: google.com
+      port: 80
   fast-www:
     good:
       strategy: http 
@@ -38,7 +46,7 @@ services:
       slow: 350
       fast: 250
 
-#log: [ 'change', 'fail', 'pass', 'up', 'down' ]
+log: [ 'change', 'fail', 'pass', 'up', 'down' ]
 
 dashboard:
   port: 3000
@@ -57,8 +65,6 @@ sync:
     day:  60000
     week: 60000
 
-  stats: true
-  sensors: true
   redis:
     port: 6379
     host: localhost