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.
   5 This library allows any Ruby application to read, write and delete
   6 files in a MogileFS instance.
   7
   8 == Links
   9
  10 rdoc :: https://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 :: https://bogomips.org/mogilefs-client-public
  15 repo :: https://bogomips.org/mogilefs-client.git
  16 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
  17 download :: https://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 to a public
  39 inbox.  HTML email is considered spam and discarded.  No subscription
  40 is required or available to post:
  41
  42         mogilefs-client-public@bogomips.org
  43
  44 Users of anonymous remailers and other anonymity tools are welcome.
  45 Participants will never be asked to reveal their identity.
  46
  47 List archives: https://bogomips.org/mogilefs-client-public/
  48
  49 We may also piggy-back onto the public MogileFS mailing list at
  50 mogile@googlegroups.com for feedback (subscription required,
  51 unfortunately)
  52
  53 Do not expect us to read HTML mail under any circumstances.
  54
  55 == WARNING!
  56
  57 This client is only supported in HTTP mode.  NFS mode was previously
  58 supported in 1.3.x, but since MogileFS 2.x dropped support for NFS
  59 in in 2006, this client does not support it.