Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
David Petersen authored and David Petersen committed Feb 21, 2012
1 parent bfed801 commit 7490d57
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,39 @@ Subway
Subway is an IRC client/server combination.
The server supports multiple simultaneous users. The client is a modern
JavaScript-heavy web interface. Client/server communication is done with
websockets (or best available fallback) via socket.io.
websockets (or best available fallback) via socket.io. If the the user is
logged in the client will stay persistant and log the channel why the user is
away.

The inspiration from this project was trying to watch a fellow programmer try
to explain how to set up screen/irssi to a non-technical person.

Subway is built with [node.js](http://nodejs.org/) and
Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
and [Backbone.js](http://documentcloud.github.com/backbone/) and
[jQuery](http://jquery.com/) on the frontend.

**[Try Subway on Nodester](http://subway.nodester.com)**
**[Try Subway on RideZap](http://ridezap.com:3000)**

Screenshots
------------
![Overview](http://people.oregonstate.edu/~petersed/overview.png)
![Chat](http://people.oregonstate.edu/~petersed/chat.png)

Installation
------------

*Should be something like this, once implemented:*

1. Assuming you already have node.js & npm, run:
1. Assuming you already have node.js, npm, and mongo, run:

$ npm install -g subway

2. Launch the web server

$ node bin/subway

3. Point your browser at `http://localhost:8337/`
3. Point your browser at `http://localhost:3000/`


Development
Expand Down

0 comments on commit 7490d57

Please sign in to comment.