update readme
This commit is contained in:
parent
137d4eeb2b
commit
33bb8e3760
30
README.md
30
README.md
@ -2,10 +2,14 @@ NAME
|
|||||||
----
|
----
|
||||||
mongoid_grid_fs
|
mongoid_grid_fs
|
||||||
|
|
||||||
|
INSTALL
|
||||||
|
-------
|
||||||
|
gem install mongoid_grid_fs
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
|
|
||||||
````ruby
|
````ruby
|
||||||
|
|
||||||
require 'mongoid-grid_fs'
|
require 'mongoid-grid_fs'
|
||||||
|
|
||||||
@ -16,34 +20,34 @@ SYNOPSIS
|
|||||||
GridFS.delete id
|
GridFS.delete id
|
||||||
|
|
||||||
|
|
||||||
````
|
````
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
mongoid_grid_fs is pure mongoid 3 / moped implementation of the mongodb
|
mongoid_grid_fs is pure mongoid 3 / moped implementation of the mongodb
|
||||||
grid_fs specification
|
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)
|
- implementation is on top of mongoid for portability. moped (the drive)
|
||||||
is barely used
|
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
|
- #[] and #[]= methods which allow the grid to be used like a giant file
|
||||||
hash in the sky
|
hash in the sky
|
||||||
|
|
||||||
- supprt for data_uris
|
- supprt for data_uris
|
||||||
|
|
||||||
````eruby
|
````eruby
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user