Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 89 lines (60 sloc) 2.952 kb
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
4 *(Note: this is aspirational. Not implemented yet!)*
5
6 Subway is an IRC client/server combination. The server works for multiple simultaneous users, with optional persistent connections and logging. The client is a modern JavaScript-heavy web interface. Server/client communication is done with websockets (or best available fallback) via socket.io.
7
8 Subway utilizes [node.js](http://nodejs.org/) and
9 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
10 and [Backbone.js](http://documentcloud.github.com/backbone/) and
11 [jQuery](http://jquery.com/) on the frontend.
12
13
14 Status
15 ------
16
17 Nothing works yet. Functionality to come shortly. If you'd like to contribute,
18 there is plenty to do. Tickets for needed functionality also to come shortly.
19
20 Installation
21 ------------
22
23 *Should be something like this, once implemented:*
24
25 1. Assuming you already have node.js & npm, run:
26
27 $ npm install -g subway
28
29 2. Launch the web server
30
31 $ subway
32
33 3. Point your browser at `http://localhost:8337/`
34
35 Development
36 -----------
37
38 *Should be about like this, once implemented:*
39
40 Replace step 1 above with this:
41
42 $ git clone https://github.com/thedjpetersen/subway.git
43 $ cd subway
44 $ npm link
45
46 this should install dependencies, and link the git checkout to your global
47 node_modules directory.
48
49 History
50 -------
51
52 Subway is a combination of two projects that started independently
53 with a similar technology stack and similar aims:
54
55 - [subway web](https://github.com/thedjpetersen/subway-web) /
56 [subway server](https://github.com/thedjpetersen/subway-server)
57 by David Petersen
58 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
59
60 Its goals are twofold:
61 1) Become the best web-based IRC client available
62 2) Provide a really easy method of persistent IRC connections, available
63 from any web browser
64
65
66 License
67 -------
68
69 The MIT License (MIT)
70 Copyright (c) 2011 David Petersen
71
72 Permission is hereby granted, free of charge, to any person obtaining a copy of
73 this software and associated documentation files (the "Software"), to deal in
74 the Software without restriction, including without limitation the rights to
75 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
76 of the Software, and to permit persons to whom the Software is furnished to do
77 so, subject to the following conditions:
78
79 The above copyright notice and this permission notice shall be included in all
80 copies or substantial portions of the Software.
81
82 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
83 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
84 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
85 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
86 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
87 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
88 SOFTWARE.
Something went wrong with that request. Please try again.