From 85266f91e06c59237915de8d03cd58cfc9ab1823 Mon Sep 17 00:00:00 2001
From: Lloyd Brookes <lloyd.brookes@gmail.com>
Date: Wed, 5 Feb 2014 15:28:23 +0100
Subject: [PATCH] readme, lint

---
 .jshintrc | 18 ++++++++++++++++++
 README.md | 20 ++++++++++++++++++++
 ws.js     | 15 ++++++++-------
 3 files changed, 46 insertions(+), 7 deletions(-)
 create mode 100644 .jshintrc

diff --git a/.jshintrc b/.jshintrc
new file mode 100644
index 0000000..ef86c4c
--- /dev/null
+++ b/.jshintrc
@@ -0,0 +1,18 @@
+{
+    "bitwise": true,
+    "camelcase": true,
+    "eqeqeq": true,
+    "globals": { "describe" : false, "it": false, "beforeEach": false },
+    "globalstrict": false,
+    "indent": 4,
+    "latedef": true,
+    "laxbreak": true,
+    "maxparams": 3,
+    "multistr": true,
+    "newcap": true,
+    "node": true,
+    "quotmark": "double",
+    "trailing": true,
+    "undef": true,
+    "unused": "strict"
+}
diff --git a/README.md b/README.md
index 6b265aa..572eaa1 100644
--- a/README.md
+++ b/README.md
@@ -54,4 +54,24 @@ Alternatively, pipe directly from ws into logstalgia for real-time visualisation
 $ ws --log-format default | logstalgia -
 ```
 
+Use with glTail
+---------------
+To use with [glTail](http://www.fudgie.org), write your log to disk using the "default" format: 
+```sh
+$ ws -f default > web.log
+```
+
+Then specify this file in your glTail config: 
+
+```yaml
+servers:
+    dev:
+        host: localhost
+        source: local
+        files: /Users/Lloyd/Documents/MySite/web.log
+        parser: apache
+        color: 0.2, 0.2, 1.0, 1.0
+```
+
+
 [![NPM](https://nodei.co/npm-dl/local-web-server.png?months=3)](https://nodei.co/npm/local-web-server/)
diff --git a/ws.js b/ws.js
index 96b32bf..07599e8 100755
--- a/ws.js
+++ b/ws.js
@@ -1,16 +1,17 @@
-#!/usr/bin/env node 
+#!/usr/bin/env node
 var connect = require("connect"),
     http = require("http"),
     Thing = require("nature").Thing,
     wodge = require("wodge");
 
+var usage = "usage: ws [--port|-p <port>] [--log-format|-f dev|default|short|tiny]";
+
 function halt(message){
     console.log(wodge.red("Error ") + message);
     console.log(usage);
     process.exit(1);
 }
 
-var usage = "usage: ws [--port|-p <port>] [--log-format|-f dev|default|short|tiny]";
 var options = new Thing()
     .define({ name: "port", alias: "p", type: "number", defaultOption: true, value: 8000 })
     .define({ name: "log-format", alias: "f", type: "string", value: "dev" })
@@ -21,16 +22,16 @@ var options = new Thing()
     .set(process.argv);
 
 if (!options.valid){
-    halt(options.validationMessages)
+    halt(options.validationMessages);
 
 } else if (options.help){
     console.log(usage);
 
 } else {
     /**
-    customised connect.logger :date token, purely to satisfy Logstalgia. 
+    customised connect.logger :date token, purely to satisfy Logstalgia.
     */
-    connect.logger.token('date', function(req, res){ 
+    connect.logger.token("date", function(){
         var a = new Date();
         return (a.getDate() + "/" + a.getUTCMonth() + "/" + a.getFullYear() + ":" + a.toTimeString())
                 .replace("GMT", "").replace(" (BST)", "");
@@ -41,11 +42,11 @@ if (!options.valid){
         .use(connect.compress())
         .use(connect.static(process.cwd()))
         .use(connect.directory(process.cwd(), { icons: true }));
-        
+
     http.createServer(app)
         .on("error", function(err){
             if (err.code === "EADDRINUSE"){
-                halt("port " + options.port + " is already is use")
+                halt("port " + options.port + " is already is use");
             } else {
                 halt(err.message);
             }