diff --git a/README.md b/README.md index 84266b0..874dafc 100644 --- a/README.md +++ b/README.md @@ -10,26 +10,33 @@ If you have the source, you can generate the matching documentation by typing $ rake ydoc -Then open the file +ydoc/index.html+. +Then open the file ydoc/index.html in your browser. # Introduction This is the 10gen-supported Ruby driver for [MongoDB](http://www.mongodb.org). -This documentation includes other articles of interest, include: +For the reference manual, use the links in the upper-left and upper-right corners for quick navigation to the following. -1. [A tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html). -2. [Replica Sets in Ruby](http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html). -3. [Write Concern in Ruby](http://api.mongodb.org/ruby/current/file.WRITE_CONCERN.html). -4. [Tailable Cursors in Ruby](http://api.mongodb.org/ruby/current/file.TAILABLE_CURSORS.html). -5. [Read Preference in Ruby](http://api.mongodb.org/ruby/current/file.READ_PREFERENCE.html). -6. [GridFS in Ruby](http://api.mongodb.org/ruby/current/file.GridFS.html). -7. [Frequently Asked Questions](http://api.mongodb.org/ruby/current/file.FAQ.html). -8. [History](http://api.mongodb.org/ruby/current/file.HISTORY.html). -9. [Release plan](http://api.mongodb.org/ruby/current/file.RELEASES.html). -10. [Credits](http://api.mongodb.org/ruby/current/file.CREDITS.html). +* [Alphabetic Index](_index.html) +* [Class List](class_list.html) +* [Method List](method_list.html) +* [File List](file_list.html) -Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html) +This documentation has other articles of interest, including: + +1. [A tutorial](file.TUTORIAL.html). +2. [Replica Sets in Ruby](file.REPLICA_SETS.html). +3. [Write Concern in Ruby](file.WRITE_CONCERN.html). +4. [Tailable Cursors in Ruby](file.TAILABLE_CURSORS.html). +5. [Read Preference in Ruby](file.READ_PREFERENCE.html). +6. [GridFS in Ruby](file.GridFS.html). +7. [Frequently Asked Questions](file.FAQ.html). +8. [History](file.HISTORY.html). +9. [Release plan](file.RELEASES.html). +10. [Credits](file.CREDITS.html). + +Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](file.TUTORIAL.html) for much more: require 'rubygems' diff --git a/docs/GridFS.md b/docs/GridFS.md index 03b3eb1..1ae3cbb 100644 --- a/docs/GridFS.md +++ b/docs/GridFS.md @@ -88,7 +88,7 @@ Deleting a file is as simple as providing the id: ### The GridFileSystem class -[GridFileSystem](http://api.mongodb.org/ruby/current/Mongo/GridFileSystem.html) is a light emulation of a file system and therefore has a couple of unique properties. The first is that filenames are assumed to be unique. The second, a consequence of the first, is that files are versioned. To see what this means, let's create a GridFileSystem instance: +[GridFileSystem](Mongo/GridFileSystem.html) is a light emulation of a file system and therefore has a couple of unique properties. The first is that filenames are assumed to be unique. The second, a consequence of the first, is that files are versioned. To see what this means, let's create a GridFileSystem instance: #### Saving files @@ -154,5 +154,5 @@ All of the options for storing metadata and saving in safe mode are available fo ### Advanced Users -Astute code readers will notice that the Grid and GridFileSystem classes are merely thin wrappers around an underlying [GridIO class](http://api.mongodb.org/ruby/current/Mongo/GridIO.html). This means that it's easy to customize the GridFS implementation presented here; just use GridIO for all the low-level work, and build the API you need in an external manager class similar to Grid or GridFileSystem. +Astute code readers will notice that the Grid and GridFileSystem classes are merely thin wrappers around an underlying [GridIO class](Mongo/GridIO.html). This means that it's easy to customize the GridFS implementation presented here; just use GridIO for all the low-level work, and build the API you need in an external manager class similar to Grid or GridFileSystem.