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 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 - no saving of connection-settings
  43 - Only one connection per time allowed
  44 - Not multi-user ready
  45
  46
  47 Browser Support
  48 ----------------
  49
  50 In general, you need a browser with websocket-support,
  51 if you want to use an older browser without websockets,
  52 you need to have flash player >= 10 installed.
  53
  54 - Tested Browsers:
  55  Firefox 15+
  56  Safari 5+
  57  Opera 12+
  58  Chrome 18+
  59
  60
  61 Installation
  62 ------------
  63
  64 1. Download and install NodeJS from http://nodejs.org
  65 2. open a terminal and cd into the JIRC-directory
  66 3. type in "node JIRC.js"
  67 4. that's it