Permalink
Browse files

Cleanup

  • Loading branch information...
1 parent 4eb3ab0 commit 261edd8be0e5826aeed02790b67ae13945131e06 @hueniverse hueniverse committed Dec 5, 2012
Showing with 29 additions and 11 deletions.
  1. +1 −1 LICENSE
  2. +8 −3 README.md
  3. +1 −1 index.js
  4. 0 lib/{helmet.js → index.js}
  5. +4 −2 package.json
  6. +15 −4 test/helmet.js
View
2 LICENSE 100644 → 100755
@@ -1,4 +1,4 @@
-Copyright (c) 2011-2012, Walmart.
+Copyright (c) 2012, Walmart.
All rights reserved.
Redistribution and use in source and binary forms, with or without
View
11 README.md 100644 → 100755
@@ -1,4 +1,9 @@
-helmet
-======
+# helmet
+
+Interactive debug console for [**hapi**](https://github.com/walmartlabs/hapi)
+
+The debug console is a simple web page in which developers can subscribe to a debug id (or * for all), and then include that
+debug id as an extra query parameter with each request. The server will use WebSocket to stream the subscribed request logs to
+the web page in real-time. To enable the debug console in a **hapi** application, set the server's `debug` option to true or
+to an object with custom configuration as described in the **hapi** documentation.
-Interactive debug console
View
2 index.js 100644 → 100755
@@ -1 +1 @@
-module.exports = require('./lib/helmet');
+module.exports = require('./lib');
File renamed without changes.
View
@@ -1,6 +1,6 @@
{
"name": "hapi-helmet",
- "description": "Interactive debug console",
+ "description": "Interactive debug console for hapi",
"version": "0.0.1",
"author": "Eran Hammer <eran@hueniverse.com> (http://hueniverse.com)",
"contributors":[
@@ -10,7 +10,9 @@
"repository": "git://github.com/walmartlabs/helmet",
"main": "index",
"keywords": [
- "docs"
+ "debug",
+ "console",
+ "hapi"
],
"engines": {
"node": ">=0.8.0"
View
19 test/helmet.js 100644 → 100755
@@ -1,8 +1,19 @@
-var expect = require('chai').expect;
+// Load modules
+
+var Chai = require('chai');
var Websocket = require('ws');
-var libPath = process.env.TEST_COV ? '../lib-cov/' : '../lib/';
-var Helmet = require(libPath + 'helmet');
-var Os = require('os')
+var Helmet = process.env.TEST_COV ? require('../lib-cov') : require('../lib');
+
+
+// Declare internals
+
+var internals = {};
+
+
+// Test shortcuts
+
+var expect = Chai.expect;
+
describe('Helmet', function() {

0 comments on commit 261edd8

Please sign in to comment.