README

   1 = LWES - Light Weight Event System bindings for Ruby
   2
   3 * http://www.lwes.org
   4 * git://reality-escapes.me/git/lwes-ruby.git
   5
   6 == DESCRIPTION:
   7
   8 The LWES Light-Weight Event System is a framework for allowing the exchange of
   9 information from many machines to many machines in a controlled, platform
  10 neutral, language neutral way.  The exchange of information is done in a
  11 connectless fashion using multicast or unicast UDP, and using self describing
  12 data so that any platform or language can translate it to it's local dialect.
  13
  14 Instead of blindly using SWIG-generated bindings and exposing users to the
  15 underlying C APIs, we've wrapped the underlying C library bindings in an
  16 easy-to-use Ruby library.  Currently we only support emitting events but
  17 may support listening and journaling capabilities as time allows.
  18
  19 == FEATURES:
  20
  21 * easy-to-use, "Ruby-ish" API, no manual memory management
  22 * optional ESF (event specification format) validation support
  23
  24 == SUPPORT:
  25
  26 Email the author: Erik S. Chang mailto:esc@reality-escapes.me and expect a
  27 response within 72 hours.
  28
  29 == DEVELOPMENT:
  30
  31 Our git repository is here:
  32
  33   git clone git://reality-escapes.me/git/lwes-ruby.git
  34
  35 Email pull requests or patches to the the author
  36 mailto:esc@reality-escapes.me
  37
  38 == INSTALL:
  39
  40 This library is easy to install, if you have the LWES library already
  41 installed you can use that, otherwise the RubyGems installer will
  42 automatically download and install a private copy only for use with your
  43 gem.
  44
  45   gem install lwes
  46
  47 == SYNOPSIS
  48
  49 See link:LWES.html
  50
  51 == NON-ESF USERS:
  52
  53 For prototyping and development, it may be easier to not use an ESF
  54 file.  In those cases, you may skip the TypeDB steps entirely and
  55 just use an emitter to send Hash objects.
  56
  57 See "NON-ESF USERS" section in link:LWES/Emitter.html