Skip to content
This repository
Newer
Older
100644 108 lines (74 sloc) 3.634 kb
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
1 Subway
2 ======
04e52b32 »
2011-12-20 Adding a README
3
bd36737d »
2012-02-25 A bunch of README changes:
4 Subway is a web-based IRC client with a multi-user backend and a
5 JavaScript-heave UI. Frontend/backend communication is done with
6 websockets (or best available fallback where not available).
7 The backend supports connection persistence and optional logging when the
8 browser disconnects.
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
9
11faffeb »
2012-02-20 Updating readme
10 Subway is built with [node.js](http://nodejs.org/),
bd36737d »
2012-02-25 A bunch of README changes:
11 [node-irc](https://github.com/martynsmith/node-irc)
12 and [MongoDB](http://www.mongodb.org/) on the backend,
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
13 and [Backbone.js](http://documentcloud.github.com/backbone/) and
14 [jQuery](http://jquery.com/) on the frontend.
15
d4f8fff9 »
2012-02-20 Update readme
16 **[Try Subway on RideZap](http://ridezap.com:3000)**
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
17
7490d57e »
2012-02-20 Updating readme
18 Screenshots
19 ------------
20 ![Overview](http://people.oregonstate.edu/~petersed/overview.png)
21 ![Chat](http://people.oregonstate.edu/~petersed/chat.png)
22
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
23 Installation
24 ------------
25
26 *Should be something like this, once implemented:*
27
7490d57e »
2012-02-20 Updating readme
28 1. Assuming you already have node.js, npm, and mongo, run:
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
29
bd36737d »
2012-02-25 A bunch of README changes:
30 $ git clone https://github.com/thedjpetersen/subway.git
31 $ cd subway
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
32
33 2. Launch the web server
34
bd36737d »
2012-02-25 A bunch of README changes:
35 $ node subway
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
36
7490d57e »
2012-02-20 Updating readme
37 3. Point your browser at `http://localhost:3000/`
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
38
cafe5aac »
2012-01-28 Misc. tweaks to README.
39
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
40 Development
41 -----------
42
bd36737d »
2012-02-25 A bunch of README changes:
43 Discussion about the client takes place on the freenode channel **#subway**, and on
44 this repository's [Issues](https://github.com/thedjpetersen/subway/issues) page.
45 Contributors are welcome and greatly appreciated.
0dc270b7 »
2012-02-21 Update README.md
46
cafe5aac »
2012-01-28 Misc. tweaks to README.
47
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
48 History
49 -------
50
dba9b54f »
2012-01-28 Add note about third-party asset licensing.
51 Subway is a combination of two projects that started independently
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
52 with a similar technology stack and similar aims:
53
dba9b54f »
2012-01-28 Add note about third-party asset licensing.
54 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb2 »
2011-12-21 Formatting changes.
55 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
56 by David Petersen
57 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
58
59 Its goals are twofold:
60 1) Become the best web-based IRC client available
61 2) Provide a really easy method of persistent IRC connections, available
62 from any web browser
63
bd36737d »
2012-02-25 A bunch of README changes:
64 The inspiration for Subway was trying to watch a fellow programmer try
65 to explain how to set up screen/irssi to a non-technical person.
66
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
67
002f40a5 »
2012-01-28 Add credits to README.
68 Credits
69 -------
70
71 Major Subway contributors include:
72
73 - [David Petersen](https://github.com/thedjpetersen), developer
74 - [Aaron Kavlie](https://github.com/akavlie), developer
75 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
bd36737d »
2012-02-25 A bunch of README changes:
76 - Yusuke Kamiyamane, some icons
002f40a5 »
2012-01-28 Add credits to README.
77
e2de5dca »
2012-03-01 Update README.md
78 **The logo right now is a Gowalla icon, we are not planning on keeping this, we are only planning on using it as a placeholder**
79
dba9b54f »
2012-01-28 Add note about third-party asset licensing.
80
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
81 License
82 -------
83
dba9b54f »
2012-01-28 Add note about third-party asset licensing.
84 Excepting third-party assets (licensed as specified in their respective files
85 or directories), this project is covered by the MIT License:
86
87
28756ab0 »
2011-12-21 Add a bunch of stuff to the README.
88 The MIT License (MIT)
89 Copyright (c) 2011 David Petersen
90
91 Permission is hereby granted, free of charge, to any person obtaining a copy of
92 this software and associated documentation files (the "Software"), to deal in
93 the Software without restriction, including without limitation the rights to
94 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
95 of the Software, and to permit persons to whom the Software is furnished to do
96 so, subject to the following conditions:
97
98 The above copyright notice and this permission notice shall be included in all
99 copies or substantial portions of the Software.
100
101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
102 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
103 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
104 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
105 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
106 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
107 SOFTWARE.
Something went wrong with that request. Please try again.