fixed 0000022
[JIRC.git] / README
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 v0.9
19 - new feature: aliases
20 - new feature: perform
21 - improved settings dialog
22 - many many bug fixes
23
24 v0.9-beta2
25 - Connection-Settings will be saved now using local storage
26 - Colors (and color stripping) are now working correctly
27 (0000002, 0000009)
28 - Username and realname are now filled automatically
29 if user types in a nickname in the connection dialog
30 - Connection dialog has now a field for server-password
31 (0000005)
32 - Button title of channel becomes blue on new messages,
33 if the window stays in background (0000008)
34 - Minor bug fixes (0000003,0000004,0000006,0000007,0000010)
35
36
37 Known Issues
38 ------------
39
40 - No error-handling in the backend
41 - No error-handling in UI-dialogs
42 - Only one connection per time allowed
43 - Not multi-user ready
44
45
46 Browser Support
47 ---------------
48
49 In general, you need a browser with websocket-support,
50 if you want to use an older browser without websockets,
51 you need to have flash player >= 10 installed.
52
53 - Tested Browsers:
54 Firefox 15+
55 Safari 5+
56 Opera 12+
57 Chrome 18+
58
59
60 Installation
61 ------------
62
63 1. Download and install NodeJS from http://nodejs.org
64 2. open a terminal and cd into the JIRC-directory
65 3. type in "node JIRC.js"
66 4. that's it