Skip to content

Commit

Permalink
Readme, configure, package.json updates, adds version history
Browse files Browse the repository at this point in the history
  • Loading branch information
msmathers committed Sep 23, 2011
1 parent 4631c34 commit 7f529e3
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 42 deletions.
17 changes: 17 additions & 0 deletions History.md
@@ -0,0 +1,17 @@
# 0.2.0 / 2011-09-23

- Updates all components to use socket.io v0.8.x
- Uses custom events (emit) instead of message_type properties
- Server uses rooms per log file for selective broadcasting
- Harvester uses "official" socket.io-client instead of Socket.io-node-client
- Unit test updates

# 0.1.2 / 2011-07-01

- socket.io v0.7 warnings, configuration updates
- Fixes broken Socket.io-node-client dependency
- Readme updates

# 0.1.1 / 2011-05-20

- Initial release
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -13,14 +13,14 @@ Users create *stream* and *history* screens to view and search log messages.

[node.js](http://nodejs.org)

[socket.io v0.6.17](http://socket.io) (Log.io is currently incompatible with socket.io v0.7.x)
[socket.io](http://socket.io)

[socket.io-client](https://github.com/LearnBoost/socket.io-client)

[connect](http://senchalabs.github.com/connect/)

[underscore](http://documentcloud.github.com/underscore/)

[Socket.io-node-client](https://github.com/msmathers/Socket.io-node-client)

## Compatibility

Harvesters & server have been tested on *Ubuntu 11.04*
Expand Down
49 changes: 15 additions & 34 deletions bin/configure.js
Expand Up @@ -4,23 +4,26 @@ try {
e("Checking for node.js package 'socket.io'...");
var io = require('socket.io');
var version = io.version;
if (version.indexOf("0.7") >= 0) {
e("ERROR: Log.io is currently incompatible with socket.io v0.7");
e("Be sure to use v0.6.17");
e("");
e("sudo npm install -g socket.io@0.6.17");
e("... or ...");
e("https://github.com/LearnBoost/socket.io/tree/0.6.17");
if (version.indexOf("0.8") < 0) {
e("ERROR: Log.io is incompatible with pre-0.8.x versions of socket.io");
process.exit(1);
}
} catch (err) {
e("ERROR: Could not find socket.io package");
e("sudo npm install -g socket.io@0.6.17");
e("sudo npm install -g socket.io");
e("... or ...");
e("https://github.com/LearnBoost/socket.io/tree/0.6.17");
e("");
e("WARNING: Log.io is currently incompatible with socket.io v0.7");
e("Be sure to use v0.6.17");
e("https://github.com/LearnBoost/socket.io/");
process.exit(1);
}

try {
e("Checking for node.js package 'socket.io-client'...");
var io = require('socket.io-client');
} catch (err) {
e("ERROR: Could not find socket.io-client package");
e("sudo npm install -g socket.io-client");
e("... or ...");
e("https://github.com/LearnBoost/socket.io-client/");
process.exit(1);
}

Expand All @@ -46,26 +49,4 @@ try {
process.exit(1);
}

try {
e("Checking for node.js package 'Socket.io-node-client (msmathers)'...");
var client_io = require('Socket.io-node-client/io-client.js').io;
} catch (err) {
e("ERROR: Could not find Socket.io-node-client (msmathers) package");
e("https://github.com/msmathers/Socket.io-node-client");
e("");
e("NOTE: This one is tricky since there's no npm package, as well as");
e("a git tag checkout to downgrade its socket.io dependency.");
e("This is a temporary workaround until socket.io-client v0.7 works");
e("outside a browser context.");
e("");
e("# Install:");
e("cd /usr/local/lib/node_modules/");
e("sudo git clone git://github.com/msmathers/Socket.io-node-client.git");
e("cd Socket.io-node-client");
e("sudo git submodule update --init --recursive");
e("cd socket.io-node");
e("sudo git checkout 0.6.17");
process.exit(1);
}

e("Success! Now run the install script in ./install/*");
10 changes: 5 additions & 5 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "Log.io",
"version": "0.1.2",
"version": "0.2.0",
"description": "Real-time log monitoring in your browser",
"homepage": "http://logio.org",
"keywords": ["logs", "monitoring", "realtime", "socket.io", "node.js", "ajax"],
Expand All @@ -13,10 +13,10 @@
"url": "https://github.com/NarrativeScience/Log.io"
},
"dependencies": {
"socket.io": "0.6.17",
"connect": "1.5.1",
"underscore": "1.1.6",
"Socket.io-node-client": ">= 0.0.0"
"socket.io": "0.8.4",
"socket.io-client": "0.8.4",
"connect": "1.7.1",
"underscore": "1.1.7"
},
"main": "index",
"engines": { "node": ">= 0.4.9" }
Expand Down

0 comments on commit 7f529e3

Please sign in to comment.