From 33bb8e3760c15b064567e49dd410c51c1ce950a4 Mon Sep 17 00:00:00 2001 From: ahoward Date: Mon, 23 Jul 2012 00:31:01 -0600 Subject: [PATCH] update readme --- README.md | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 7841edf..a6c05f4 100644 --- a/README.md +++ b/README.md @@ -2,51 +2,55 @@ NAME ---- mongoid_grid_fs +INSTALL +------- + gem install mongoid_grid_fs + SYNOPSIS -------- - ````ruby +````ruby - require 'mongoid-grid_fs' + require 'mongoid-grid_fs' - g = GridFs.put anthing_that_respons_to_read + g = GridFs.put anthing_that_respons_to_read - GridFS.get id + GridFS.get id - GridFS.delete id + GridFS.delete id - ```` +```` DESCRIPTION ----------- - mongoid_grid_fs is pure mongoid 3 / moped implementation of the mongodb - grid_fs specification +mongoid_grid_fs is pure mongoid 3 / moped implementation of the mongodb +grid_fs specification - ref: http://www.mongodb.org/display/DOCS/GridFS+Specification +ref: http://www.mongodb.org/display/DOCS/GridFS+Specification - it has the following features: +it has the following features: - - implementation is on top of mongoid for portability. moped (the drive) - is barely used +- implementation is on top of mongoid for portability. moped (the drive) + is barely used - - simple, REST-like api +- simple, REST-like api - - support for custom namespaces (fs.files vs. image.files) +- support for custom namespaces (fs.files vs. image.files) - - pathnames and io-like objects can be written to the grid +- pathnames and io-like objects can be written to the grid - - auto-unique pathnames are generated (by default) to avoid collisions using #put +- auto-unique pathnames are generated (by default) to avoid collisions using #put - 'path/info/a.rb' -> '$object_id/a.rb' + 'path/info/a.rb' -> '$object_id/a.rb' - - #[] and #[]= methods which allow the grid to be used like a giant file - hash in the sky +- #[] and #[]= methods which allow the grid to be used like a giant file + hash in the sky - - supprt for data_uris +- supprt for data_uris - ````eruby + ````eruby - <%= image_tag :src => file.data_url %> + <%= image_tag :src => file.data_url %> - ```` + ````