about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 3 insertions, 31 deletions
diff --git a/README b/README
index d72802d..1c49e5f 100644
--- a/README
+++ b/README
@@ -27,44 +27,16 @@ Then install the RubyGem:
 This library supports Ruby 1.8.7 and later, but Ruby 1.9.3 is
 recommended.  No other libraries are required on the client.
 
-== Use
+== Usage
 
-  # Create a new instance that will communicate with these trackers:
-  hosts = %w[192.168.1.69:6001 192.168.1.70:6001]
-  mg = MogileFS::MogileFS.new(:domain => 'test', :hosts => hosts)
-
-  # Stores "A bunch of text to store" into 'some_key' with a class of 'text'.
-  mg.store_content 'some_key', 'text', "A bunch of text to store"
-
-  # Retrieve data from 'some_key'
-  data = mg.get_file_data 'some_key'
-
-  # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
-  # 'image'.
-  mg.store_file 'my_image', 'image', 'image.jpeg'
-
-  # Store the contents of 'image.jpeg' into the key 'my_image' with a class of
-  # 'image' using an open IO.
-  File.open 'image.jpeg', 'rb' do |fp|
-    mg.store_file 'my_image', 'image', fp
-  end
-
-  # Retrieve the contents of 'my_image' into '/path/to/huge_file'
-  # without slurping the entire contents into memory:
-  File.open '/path/to/huge_file', 'w' do |fp|
-    mg.get_file_data 'my_image', wr
-  end
-
-  # Remove the key 'my_image' and 'some_key'.
-  mg.delete 'my_image'
-  mg.delete 'some_key'
+See MogileFS::MogileFS
 
 == Contact
 
 Feedback (bug reports, user/development dicussion, patches, pull
 requests) are greatly appreciated and handled via email.  We currently
 piggy-back onto the public MogileFS
-{mailing list}[mailto:mogile@googlegroups.com].
+{mailing list}[mailto:mogile@googlegroups.com] for feedback.
 
 If you do not want to deal with the corporate host of the MogileFS
 mailing list, or if you wish to keep your issue secret, feel free to