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

minor: readme

This commit is contained in:
Kyle Banker 2010-10-07 17:55:36 -04:00
parent 7b3ba5e006
commit 6afb862d17
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.rdoc
View File

@ -23,7 +23,7 @@ Here's a quick code sample. See the MongoDB Ruby Tutorial
=== Ruby Versions === Ruby Versions
The driver works and is consistently tested on Ruby 1.8.6, 1.8.7, and 1.9.1. The driver works and is consistently tested on Ruby 1.8.6, 1.8.7, and 1.9.2, and JRuby 1.5.1.
Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. There Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. There
are some IO bugs in earlier versions. are some IO bugs in earlier versions.
@ -39,7 +39,7 @@ Then you can install the mongo gem as follows:
$ gem install mongo $ gem install mongo
The driver also requires the BSON gem: The driver also requires the bson gem:
$ gem install bson $ gem install bson
@ -47,6 +47,11 @@ And for a significant performance boost, you'll want to install the C extensions
$ gem install bson_ext $ gem install bson_ext
Note that bson_ext isn't used with JRuby. Instead, some native Java extensions are bundled with the bson gem.
If you ever need to modify these extenions, you can recompile with the following rake task:
$ rake build:java
=== From the GitHub source === From the GitHub source
The source code is available at http://github.com/mongodb/mongo-ruby-driver. The source code is available at http://github.com/mongodb/mongo-ruby-driver.
@ -290,7 +295,7 @@ the bson_ext C extension enabled.
$ rake test:c $ rake test:c
Or, to test without the extension: If you want to test the basic Ruby encoder, or if you're running JRuby:
$ rake test:ruby $ rake test:ruby