README

   1 = kgio-monkey - kinder, gentler, SSL/TLS I/O for Ruby
   2
   3 Wraps OpenSSL to provide {kgio-compatible}[http://bogomips.org/kgio/]
   4 kgio_trywrite and kgio_tryread IO methods to Kgio::SSL wrapper objects.
   5
   6 == WARNING!!!!!!!!1
   7
   8 This project is NOT maintained nor reviewed by anybody with any
   9 credentials in security nor cryptography, use at your own risk.
  10
  11 Security/code/all reviews are very welcome, email us at
  12 mailto:kgio-public@bogomips.org (or mailto:kgio@bogomips.org if you wish to
  13 remain anonymous).
  14
  15 This project is NOT an endorsement of OpenSSL itself.  This project uses
  16 OpenSSL only because Ruby already bundles the "openssl" extension and we
  17 don't have time to maintain full Ruby bindings for NSS or any another
  18 SSL/TLS library.
  19
  20 == Install
  21
  22 Ruby 1.8.6 and earlier is NOT supported.
  23
  24 The library consists of a C extension so you'll need a Unix-like system
  25 with a C compiler and Ruby development libraries/headers.
  26
  27 http://rubyforge.org/frs/?group_id=8977
  28
  29 You may also install it via RubyGems.org:
  30
  31   gem install kgio-monkey
  32
  33 You can get the latest source via git from the following locations
  34 (these versions may not be stable):
  35
  36   git://bogomips.org/kgio-monkey.git
  37   git://repo.or.cz/kgio-monkey.git (mirror)
  38
  39 You may browse the code from the web and download the latest snapshot
  40 tarballs here:
  41
  42 * http://bogomips.org/kgio-monkey.git (cgit)
  43 * http://repo.or.cz/w/kgio-monkey.git (gitweb)
  44
  45 See the HACKING guide on how to contribute and build prerelease gems
  46 from git.
  47
  48 == Contact
  49
  50 All feedback (bug reports, user/development dicussion, patches, pull
  51 requests) go to the mailing list/newsgroup.  See the ISSUES document for
  52 information on the {kgio mailing list}[mailto:kgio-public@bogomips.org]
  53
  54 For the latest on kgio-monkey releases, you may check our NEWS page
  55 (and subscribe to our Atom feed).