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