README in nayutaya-kagemusha-0.0.9 vs README in nayutaya-kagemusha-0.1.0
- old
+ new
@@ -1,24 +1,24 @@
-= Kagemusha - a library of testing mock-objects
+= Kagemusha - A Testing Mock-Objects Library
http://github.com/nayutaya/kagemusha/
== DESCRIPTION:
Kagemusha is a library of helper functions
for testing Ruby scripts. It helps you generating
-scoped mock-objects which overrides behavior of
-the class restricted in given blocks, without
+scoped mock-objects which overrides the behavior of
+a class only in a given blocks, without
tainting a global area.
-For example, if you override Date.today when you write
+For example, if you override Date.today when you are writing
something about dates, then the code will taint global
-areas to no purpose.
+areas involuntarily.
-If you use Kagemusha, the test code will override
-behavior of the class restricted in given block.
+But if you use Kagemusha, the test code will override
+the behavior of the class only in the given block.
Example:
require "kagemusha"
musha = Kagemusha.new(Time)
@@ -28,12 +28,12 @@
musha.swap {
p Time.now #=> Sat Jan 01 00:00:00 +0900 2000
p Time.now.to_s #=> "2000-01-01"
}
-Also, it has default useful mock-objects set Date, Time,
-rand, and so on.
+Also, it has some default useful mock-objects set include
+Date, Time and rand.
Example:
require "kagemusha/date"
musha = Kagemusha::Date.at(2000, 1, 1)
@@ -41,11 +41,11 @@
p Date.today.to_s #=> "2000-01-01"
}
== SYNOPSIS:
-see example directory.
+See the example directory.
== INSTALL:
The easiest way to get started with Kagemusha is to
install it via RubyGems. You can do this easily:
@@ -53,5 +53,10 @@
$ gem install nayutaya-kagemusha
== LICENSE:
Ruby's License
+
+== SUPPORT:
+
+Contact me.
+ Yuya Kato <yuyakato at gmail.com>