fixed 0000022

[JIRC.git] / README

JIRC: An IRC client based on websocket
======================================


Release Notes
-------------

Please do not share the code without my permission.
This is Beta-Software and not ready for the masses.
There will be a public version with 1.0.
Feel free to modify and improve the code, 
but please send me your improvements.


Changelog
---------

v0.9
- new feature: aliases
- new feature: perform
- improved settings dialog
- many many bug fixes

v0.9-beta2
- Connection-Settings will be saved now using local storage
- Colors (and color stripping) are now working correctly
  (0000002, 0000009)
- Username and realname are now filled automatically
  if user types in a nickname in the connection dialog
- Connection dialog has now a field for server-password
  (0000005)
- Button title of channel becomes blue on new messages,
  if the window stays in background (0000008)
- Minor bug fixes (0000003,0000004,0000006,0000007,0000010)


Known Issues
------------

- No error-handling in the backend
- No error-handling in UI-dialogs
- Only one connection per time allowed
- Not multi-user ready


Browser Support
---------------

In general, you need a browser with websocket-support,
if you want to use an older browser without websockets,
you need to have flash player >= 10 installed.

- Tested Browsers:
 Firefox 15+
 Safari 5+
 Opera 12+
 Chrome 18+


Installation
------------

1. Download and install NodeJS from http://nodejs.org
2. open a terminal and cd into the JIRC-directory
3. type in "node JIRC.js"
4. that's it