initial commit
[JIRC.git] / README
CommitLineData
39c8b14f 1JIRC: An IRC client based on websocket
2======================================
3
4
5Release Notes
6-------------
7
8Please do not share the code without my permission.
9This is Beta-Software and not ready for the masses.
10There will be a public version with 1.0.
11Feel free to modify and improve the code,
12but please send me your improvements.
13
14
15Changelog
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
30Known Issues
31------------
32
33- No error-handling in the backend
34- No error-handling in UI-dialogs
35- Wrong size of user-list while changing size
36- Only one connection per time allowed
37- Not multi-user ready
38
39
40Browser Support
41---------------
42
43- Tested Browsers:
44 Firefox 16
45 Safari 6
46 to be continued ...
47
48- Browsers that should work:
49 Chrome 14+
50 Firefox 7+
51 Safari 5+
52 Opera ?
53 Internet Explorer 9+
54
55
56Installation
57------------
58
591. Download and install NodeJS from http://nodejs.org
602. open a terminal and cd into the JIRC-directory
613. type in "node JIRC.js"
624. that's it