README

   1 = mogilefs-client - MogileFS client library for Ruby
   2
   3 A MogileFS client library for Ruby.  MogileFS is an open source
   4 distributed filesystem, see: http://mogilefs.org for more details.  This
   5 library allows any Ruby application to read, write and delete files in a
   6 MogileFS instance.
   7
   8 == Links
   9
  10 rdoc :: http://bogomips.org/mogilefs-client
  11 mogilefs :: http://mogilefs.org/
  12 list :: mailto:mogilefs-client-public@bogomips.org
  13 list-cc :: mailto:mogile@googlegroups.com
  14 list-archive :: http://bogomips.org/mogilefs-client-public
  15 email :: mailto:e@80x24.org
  16 repo :: git://bogomips.org/mogilefs-client.git
  17 cgit :: http://bogomips.org/mogilefs-client.git
  18 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
  19 download :: http://bogomips.org/mogilefs-client/files/
  20
  21 == Install
  22
  23 First you need a MogileFS 2.x installation.  You can find information on
  24 how to do that at http://mogilefs.org
  25
  26 Then install the RubyGem:
  27
  28   $ gem install mogilefs-client
  29
  30 This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
  31 recommended.  No other libraries are required on the client.
  32
  33 == Usage
  34
  35 See MogileFS::MogileFS
  36
  37 == Contact
  38
  39 Feedback (bug reports, user/development discussion, patches, pull
  40 requests) are greatly appreciated and handled via email to a public
  41 inbox.  HTML email is considered spam and discarded.  No subscription
  42 is required or available to post:
  43
  44         mogilefs-client-public@bogomips.org
  45
  46 List archives: http://bogomips.org/mogilefs-client-public/
  47
  48 We may also piggy-back onto the public MogileFS mailing list at
  49 mogile@googlegroups.com for feedback (subscription required,
  50 unfortunately)
  51
  52 If you wish to keep your issue secret, feel free to email the author at:
  53
  54                 e@80x24.org
  55
  56 Do not expect us to read HTML mail under any circumstances.
  57
  58 == WARNING!
  59
  60 This client is only supported in HTTP mode.  NFS mode was previously
  61 supported in 1.3.x, but since MogileFS 2.x has dropped support for
  62 NFS, this client has removed support for it.