summaryrefslogtreecommitdiff
path: root/RC9/qpid/ruby/README.txt
diff options
context:
space:
mode:
authorRafael H. Schloming <rhs@apache.org>2009-01-13 18:11:43 +0000
committerRafael H. Schloming <rhs@apache.org>2009-01-13 18:11:43 +0000
commit7e34266b9a23f4536415bfbc3f161b84615b6550 (patch)
tree484008cf2d413f58b5e4ab80b373303c66200888 /RC9/qpid/ruby/README.txt
parent4612263ea692f00a4bd810438bdaf9bc88022091 (diff)
downloadqpid-python-M4.tar.gz
Tag M4 RC9M4
git-svn-id: https://svn.apache.org/repos/asf/qpid/tags/M4@734202 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'RC9/qpid/ruby/README.txt')
-rw-r--r--RC9/qpid/ruby/README.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/RC9/qpid/ruby/README.txt b/RC9/qpid/ruby/README.txt
new file mode 100644
index 0000000000..b68a41b7b4
--- /dev/null
+++ b/RC9/qpid/ruby/README.txt
@@ -0,0 +1,22 @@
+= INSTALLATION =
+
+Extract the release archive into a directory of your choice and set
+your RUBYLIB environment variable accordingly:
+
+ tar -xzf qpid-ruby-<version>.tar.gz -C <install-prefix>
+ export RUBYLIB=<install-prefix>/qpid-<version>/ruby/lib
+
+= GETTING STARTED =
+
+The ruby client includes a simple hello-world example that publishes
+and consumes a message:
+
+ cp <install-prefix>/qpid-<version>/ruby/examples/hello-world.rb .
+ ./hello-world.rb
+
+= RUNNING THE TESTS =
+
+The "tests" directory contains a collection of unit tests for the ruby
+client. These can be run with the Rakefile provided:
+
+ ./rake test