github-migration/mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Jim Menard 2009-01-07 16:07:22 -05:00
parent 60ab3d99dc
commit c08ad81e51
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.rdoc
View File

@ -1,18 +1,21 @@
= Introduction = Introduction
This is a simple pure-Ruby driver for the 10gen Mongo DB. For more information This is a Ruby driver for the 10gen Mongo DB. For more information about
about Mongo, see http://www.mongodb.org. Mongo, see http://www.mongodb.org.
Note: this driver is still alpha quality. The API will change, as may the Note: this driver is still alpha quality. The API will change, as *may* the
data saved to the database (especially primary key values). Do *_not_* use this data saved to the database (especially primary key values). Do *_not_* use
for any production data yet. this for any production data yet.
= Demo = Demo
Mongo must be running, of course.
$ ruby examples/simple.rb $ ruby examples/simple.rb
Mongo must be running, of course. See also the test code, especially
http://github.com/jimm/mongo-ruby-driver/tree/master/tests/test_db_api.rb
= Testing = Testing
@ -28,16 +31,11 @@ The tests assume that the Mongo database is running on the default port.
Then open the file doc/index.html. (I need to figure out where to put this on Then open the file doc/index.html. (I need to figure out where to put this on
the Web, or perhaps how to publish this to the Wiki at the Web, or perhaps how to publish this to the Wiki at
http://github.com/jimm/mongo-ruby-driver/wikis automatically.) http://github.com/jimm/mongo-ruby-driver/wikis automatically. I have applied
for a RubyForge project, so the docs will eventually go there.)
= The Code = Release Notes
Most of this code was transliterated from Geir Magnusson Jr's Java Mongo
driver, which can be found at
http://github.com/geir/mongo-java-driver/tree/master.
== Release Notes
See the git log comments. See the git log comments.