README.rdoc in param_checker-0.0.4 vs README.rdoc in param_checker-0.1.0

@@ -1,8 +1,8 @@
 = ParamChecker
 
-ParamChecker is a small library for validation and parsing of user provided parameters. It is a handy way to check GET/POST params in Ruby webframeworks (like Rails or Sinatra).
+ParamChecker is a small Ruby library for validating and casting string parameters. It is for example a handy way to check GET/POST +params+ in Ruby On Rails.
 
 == Installation
 
   gem install param_checker
 
@@ -20,13 +20,13 @@
 
   class ApplicationController < ActionController::Base
     include ParamChecker
   end
 
-You can then simply call <tt>check_string(param_to_check, "my default", ["foo", "bar"])</tt> in every controller.
+You can then simply call for example <tt>check_string(param_to_check, "my default", ["foo", "bar"])</tt> in every controller.
 
-Instead of including the module you could also call all functions of the module directly.
+Instead of including the module you could also call all functions of the module directly, like
 
   ParamChecker.check_string(param_to_check, "my default", ["foo", "bar"])
 
 There are currently 5 supported functions:
 
@@ -34,14 +34,16 @@
   check_float(param, default, min, max)
   check_string(param, default, allowed)
   check_symbol(param, default, allowed)
   check_boolean(param, default)
 
-+param+ is always the string parameter to check. +default+ is a value that is returned when +param+ does not succeed the check.
-+min+ and +max+ in +check_integer+ and +check_float+ are the minimum and maximum allowed values of param. Both +min+ and +max+ options are optional. If they are not provided then no range is checked at all.
-+allowed+ in +check_string+ and +check_symbol+ represent the allowed values of +param+. They can be either a string (resp. a symbol for +check_symbol+), a regular expression, or an array of strings (resp. symbols for +check_symbol+).
-+check_boolean+ evaluates "1" or "true" string as true and "0" or "false" string to false.
-All functions return the parsed and type cast value (check_integer returns an integer, check_symbol returns a symbol, and so on).
+* +param+ (_required_) is the string parameter to check.
+* +default+ (_required_) is the value that is returned when +param+ does not pass the check.
+* +min+ (_optional_), +max+ (_optional_) in +check_integer+ and +check_float+ are the minimum and maximum allowed values of param. (If not provided then no range is checked at all.)
+* +allowed+ (_optional_) in +check_string+ and +check_symbol+ represent the allowed values of +param+. They can be either a string (resp. a symbol for +check_symbol+), a regular expression, or an array of strings (resp. symbols for +check_symbol+).
+* +check_boolean+ evaluates "1" or "true" string as true and "0" or "false" string to false.
+
+All functions return the the casted value (check_integer returns an integer, check_symbol returns a symbol, and so on).
 
 == Examples
 
 Below are some simple examples how I use those function in my controllers.