summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZachary Scott <zachary@zacharyscott.net>2012-10-20 17:26:54 -0400
committerZachary Scott <zachary@zacharyscott.net>2012-10-20 17:26:54 -0400
commit3e3935b62398cf0eaf3b3f50c3f3aa99ad914f5a (patch)
treebab389a6942b418f44d163d11d2a8ae4eb25d3f3
parent4be2aef4d385aaeb995ff3024534d357dff30d8e (diff)
downloadpsych-3e3935b62398cf0eaf3b3f50c3f3aa99ad914f5a.tar.gz
Install documentation, fixes #91
-rw-r--r--README.rdoc24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.rdoc b/README.rdoc
index 0294e31..93ba51d 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -23,8 +23,28 @@ to and from the YAML format.
== Installation
-* sudo port install libyaml +universal
-* sudo install_ruby.sh
+Psych has been included with MRI since 1.9.2,
+and is the fault YAML parser in 1.9.3.
+
+If you want a newer gem release of Psych, you can use rubygems:
+
+ gem install psych
+
+In order to use the gem release in your app,
+and not the stdlib version, you'll need the following:
+
+ gem 'psych'
+ require 'psych'
+
+Or if you use Bundler add this to your +Gemfile+:
+
+ gem 'psych'
+
+JRuby ships with a pure Java implementation of Psych.
+
+If you're on Rubinius, Psych is available in 1.9 mode, please refer to the
+{Rubinius Documentation}[http://rubini.us/doc/en/build-system/] for more
+information on building and 1.9 mode.
== License