socket_common: improve readability of case statement
[ruby-mogilefs-client.git] / README
bloba3f1ae4560c886351b0b5919e984292e69b01c7c
1 = mogilefs-client - MogileFS client library for Ruby
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.
8 == Links
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 :: git://bogomips.org/mogilefs-client.git
16         https://bogomips.org/mogilefs-client.git
17 gitweb :: http://repo.or.cz/w/ruby-mogilefs-client.git
18 download :: https://bogomips.org/mogilefs-client/files/
20 == Install
22 First you need a MogileFS 2.x installation.  You can find information on
23 how to do that at http://mogilefs.org
25 Then install the RubyGem:
27   $ gem install mogilefs-client
29 This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
30 recommended.  No other libraries are required on the client.
32 == Usage
34 See MogileFS::MogileFS
36 == Contact
38 Feedback (bug reports, user/development discussion, patches, pull
39 requests) are greatly appreciated and handled via email to a public
40 inbox.  HTML email is considered spam and discarded.  No subscription
41 is required or available to post:
43         mogilefs-client-public@bogomips.org
45 Users of anonymous remailers and other anonymity tools are welcome.
46 Participants will never be asked to reveal their identity.
48 List archives: https://bogomips.org/mogilefs-client-public/
50 We may also piggy-back onto the public MogileFS mailing list at
51 mogile@googlegroups.com for feedback (subscription required,
52 unfortunately)
54 Do not expect us to read HTML mail under any circumstances.
56 == WARNING!
58 This client is only supported in HTTP mode.  NFS mode was previously
59 supported in 1.3.x, but since MogileFS 2.x dropped support for NFS
60 in in 2006, this client does not support it.