fixed 0000022

[JIRC.git] / README.txt

JIRC: An IRC client based on websocket\r
======================================\r
\r
\r
Release Notes\r
-------------\r
\r
Please do not share the code without my permission.\r
This is Beta-Software and not ready for the masses.\r
There will be a public version with 1.0.\r
Feel free to modify and improve the code, \r
but please send me your improvements.\r
\r
\r
Changelog\r
---------\r
\r
v0.9\r
- new feature: aliases\r
- new feature: perform\r
- improved settings dialog\r
- many many bug fixes\r
\r
v0.9-beta2\r
- Connection-Settings will be saved now using local storage\r
- Colors (and color stripping) are now working correctly\r
  (0000002, 0000009)\r
- Username and realname are now filled automatically\r
  if user types in a nickname in the connection dialog\r
- Connection dialog has now a field for server-password\r
  (0000005)\r
- Button title of channel becomes blue on new messages,\r
  if the window stays in background (0000008)\r
- Minor bug fixes (0000003,0000004,0000006,0000007,0000010)\r
\r
\r
Known Issues\r
-------------\r
\r
- No error-handling in the backend\r
- No error-handling in UI-dialogs\r
- no saving of connection-settings\r
- Only one connection per time allowed\r
- Not multi-user ready\r
\r
\r
Browser Support\r
----------------\r
\r
In general, you need a browser with websocket-support,\r
if you want to use an older browser without websockets,\r
you need to have flash player >= 10 installed.\r
\r
- Tested Browsers:\r
 Firefox 15+\r
 Safari 5+\r
 Opera 12+\r
 Chrome 18+\r
\r
\r
Installation\r
------------\r
\r
1. Download and install NodeJS from http://nodejs.org\r
2. open a terminal and cd into the JIRC-directory\r
3. type in "node JIRC.js"\r
4. that's it\r