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:mogile@googlegroups.com
  13 email :: mailto:normalperson@yhbt.net
  14 repo :: git://bogomips.org/mogilefs-client.git
  15 cgit :: http://bogomips.org/mogilefs-client.git
  16 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
  17 download :: http://bogomips.org/mogilefs-client/files/
  18
  19 == Install
  20
  21 First you need a MogileFS 2.x installation.  You can find information on
  22 how to do that at http://mogilefs.org
  23
  24 Then install the RubyGem:
  25
  26   $ gem install mogilefs-client
  27
  28 This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
  29 recommended.  No other libraries are required on the client.
  30
  31 == Usage
  32
  33 See MogileFS::MogileFS
  34
  35 == Contact
  36
  37 Feedback (bug reports, user/development discussion, patches, pull
  38 requests) are greatly appreciated and handled via email.  We currently
  39 piggy-back onto the public MogileFS
  40 mailing list at mailto:mogile@googlegroups.com for feedback.
  41
  42 If you do not want to deal with the corporate host of the MogileFS
  43 mailing list, or if you wish to keep your issue secret, feel free to
  44 email Eric Wong at mailto:normalperson@yhbt.net.
  45
  46 Do not expect Eric Wong to read HTML mail under any circumstances.
  47
  48 == WARNING!
  49
  50 This client is only supported in HTTP mode.  NFS mode was previously
  51 supported in 1.3.x, but since MogileFS 2.x has dropped support for
  52 NFS, this client has removed support for it.