summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLee Jarvis <ljjarvis@gmail.com>2014-12-17 08:41:48 +0000
committerLee Jarvis <ljjarvis@gmail.com>2014-12-17 08:41:48 +0000
commit1f9daf135d0a12b825bd2d2356f4d321f6c06fc0 (patch)
tree66be38f8273f4b90fd4832aafcb7d3a49d430feb /README.md
parent4721ef271eec40aa45b4452efdff824a05bce032 (diff)
downloadslop-1f9daf135d0a12b825bd2d2356f4d321f6c06fc0.tar.gz
Tweak README to mention Ruby version support
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 66889e3..5d9073a 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,9 @@ Slop
Slop is a simple option parser with an easy to remember syntax and friendly API.
+Version 4 of Slop is aimed at Ruby 2.0 or later. Please use
+[Version 3](https://github.com/leejarvis/slop/tree/v3) for Ruby 1.8/1.9 support.
+
[![Build Status](https://travis-ci.org/leejarvis/slop.png?branch=master)](http://travis-ci.org/leejarvis/slop)
Installation
@@ -81,7 +84,7 @@ Custom option types
-------------------
Slop uses option type classes for every new option added. They default to the
-`StringOption`. When you type `o.array` Slop looks for an option called
+`NullOption`. When you type `o.array` Slop looks for an option called
`Slop::ArrayOption`. This class must contain at least 1 method, `call`. This
method is executed at parse time, and the return value of this method is
used for the option value. We can use this to build custom option types: