Document recommended pins for Ruby 1.8/1.9

vmware-archive · Aug 22, 2016 · 13cbc2a · 13cbc2a
1 parent 727f406
commit 13cbc2a
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -16,6 +16,19 @@ be used alongside the official documentation[http://pubs.vmware.com/vsphere-60/t
 
     gem install rbvmomi
 
+=== Support for older Ruby versions
+
+RbVmomi supports Ruby 1.8.7 and higher, but certain dependencies may need
+pinning to older versions to get a compatible set of gems.
+
+On Ruby 1.8.7:
+
+* use +nokogiri+ 1.5.x (Gemfile: <code>gem 'nokogiri', '< 1.6'</code>)
+
+On both Ruby 1.9 and 1.8.7:
+
+* use +json+ 1.x (Gemfile: <code>gem 'json', '< 2'</code>)
+
 == Usage
 
 A simple example of turning on a VM: