initial commit
[JIRC.git] / README.txt
1 JIRC: An IRC client based on websocket
2 ======================================
3
4
5 Release Notes
6 -------------
7
8 Please do not share the code without my permission.
9 This is Beta-Software and not ready for the masses.
10 There will be a public version with 1.0.
11 Feel free to modify and improve the code,
12 but please send me your improvements.
13
14
15 Changelog
16 ---------
17
18 - Connection-Settings will be saved now using local storage
19 - Colors (and color stripping) are now working correctly
20 (0000002, 0000009)
21 - Username and realname are now filled automatically
22 if user types in a nickname in the connection dialog
23 - Connection dialog has now a field for server-password
24 (0000005)
25 - Button title of channel becomes blue on new messages,
26 if the window stays in background (0000008)
27 - Minor bug fixes (0000003,0000004,0000006,0000007,0000010)
28
29
30 Known Issues
31 -------------
32
33 - No error-handling in the backend
34 - No error-handling in UI-dialogs
35 - no saving of connection-settings
36 - Wrong size of user-list while changing size
37 - Only one connection per time allowed
38 - Not multi-user ready
39
40
41 Browser Support
42 ----------------
43
44 Tested Browsers:
45
46 Firefox 16
47 Safari 6 to be continued ...
48
49 - Browsers that should work:
50 Chrome 14+
51 Firefox 7+
52 Safari 5+
53 Opera ?
54 Internet Explorer 9+
55
56
57 Installation
58 ------------
59
60 1. Download and install NodeJS from http://nodejs.org
61 2. open a terminal and cd into the JIRC-directory
62 3. type in "node JIRC.js"
63 4. that's it