README

   1 = LMGTWTY: Web Sockets Library for Rack+Rainbows!
   2
   3 LMGTWTY is a Rainbows! (and Zbatery) Rack library for Web Sockets.
   4 It uses unofficial extensions for Rack which are subject to
   5 change, but it appears to work well enough for the echo_client.py
   6 example shipped with pywebsocket.
   7
   8 It has not been tested against normal web browsers, though there's
   9 no reason it shouldn't work.
  10
  11 It currently depends on the git version of Rainbows.
  12
  13 == License
  14
  15 LMGTWTY is copyright 2009 by all contributors (see logs in git).
  16
  17 LMGTWTY is 100% Free Software and licensed under the same terms
  18 as Ruby (GPL2 + Ruby License).  See the LICENSE file for more
  19 details.
  20
  21 == Install
  22
  23 You may download the tarball from the Rainbows! project page on Rubyforge
  24 and run setup.rb after unpacking it:
  25
  26 http://rubyforge.org/frs/?group_id=8977
  27
  28 You may also install it via RubyGems on Gemcutter:
  29
  30   gem install lmgtwty
  31
  32 == Usage
  33
  34 Make sure you're using one of the following concurrency models
  35 for Rainbows!:
  36
  37 * FiberSpawn
  38 * FiberPool
  39 * Revactor
  40 * ThreadSpawn
  41 * ThreadPool
  42
  43   require "lmgtwty"
  44
  45 In your application, use Lmgtwty::Request.new(env) instead of
  46 Rack::Request.new(env).  See examples/echo.ru for a full example.
  47
  48 == Disclaimer
  49
  50 There is NO WARRANTY whatsoever if anything goes wrong, but let us know
  51 and we'll try our best to fix it.
  52
  53 This API is highly unstable and designed on a whim, so it may be
  54 completely replaced.
  55
  56 == Development
  57
  58   git://git.bogomips.org/lmgtwty.git
  59
  60 You may browse the code from the web and download the latest snapshot
  61 tarballs here:
  62
  63 * http://git.bogomips.org/cgit/lmgtwty.git (cgit)
  64
  65 Inline patches (from "git format-patch") to the mailing list are
  66 preferred because they allow code review and comments in the reply to
  67 the patch.
  68
  69 We will adhere to mostly the same conventions for patch submissions as
  70 git itself.  See the Documentation/SubmittingPatches document
  71 distributed with git on on patch submission guidelines to follow.  Just
  72 don't email the git mailing list or maintainer with LMGTWTY patches.
  73
  74 == Contact
  75
  76 All feedback (bug reports, user/development dicussion, patches, pull
  77 requests) go to the mailing list/newsgroup.  Do not send HTML mail,
  78 do not top post.
  79
  80 * mailto:lmgtwty@librelist.com