From 6afb862d17ab74a25d72f76327f284cca4c3460e Mon Sep 17 00:00:00 2001 From: Kyle Banker Date: Thu, 7 Oct 2010 17:55:36 -0400 Subject: [PATCH] minor: readme --- README.rdoc | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rdoc b/README.rdoc index 044cedc..702699a 100644 --- a/README.rdoc +++ b/README.rdoc @@ -23,7 +23,7 @@ Here's a quick code sample. See the MongoDB Ruby Tutorial === 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 are some IO bugs in earlier versions. @@ -39,7 +39,7 @@ Then you can install the mongo gem as follows: $ gem install mongo -The driver also requires the BSON gem: +The driver also requires the bson gem: $ 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 +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 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 -Or, to test without the extension: +If you want to test the basic Ruby encoder, or if you're running JRuby: $ rake test:ruby