README.txt in rubydoctest-0.2.1 vs README.txt in rubydoctest-1.0.0

@@ -1,26 +1,39 @@
-= rubydoctest
+= Ruby DocTest
 
-* http://github.com/tablatom/rubydoctest
+Official repository:
+	* http://github.com/tablatom/rubydoctest
 
-== DESCRIPTION:
+Wiki documentation:
+	* http://github.com/tablatom/rubydoctest/wikis
 
-Ruby version of Python's doctest tool, but a bit different.
+== Description:
 
-== FEATURES/PROBLEMS:
+Ruby version of Python's doctest tool, but a bit different. Ruby DocTest
+allows you to:
 
-* FIX (list of features or problems)
+	1. Write tests in irb format and keep them as comments next to your Ruby code.
+	2. Write markdown documents with irb format tests embedded in them.
 
-== SYNOPSIS:
+== Synopsis:
 
-rubydoctest comes as an executable that takes a file or directory:
+rubydoctest comes as an executable that takes a list of files:
 	
-  rubydoctest .
+  rubydoctest lib/*.rb
 	rubydoctest simple.doctest
 
-== EXAMPLE:
+== Examples:
 	
+Here is how you might use RubyDocTest within a ruby source file (say called five.rb):
+
+	# doctest: Add 5 and 5 to get 10
+	# >> five_and_five
+	# => 10
+	def five_and_five
+	  5 + 5
+	end
+
 Here is an example doctest file (say called simple.doctest):
 	
 	# Simple test of RubyDocTest
 
 	This is an example test
@@ -31,79 +44,57 @@
 	And here's a test that will fail
 
 		>> 1 + 2
 		=> 4
 
-	Test a some multiline statements
+See the doc directory of this project for more .doctest examples and documentation.
 
-		>> 
-			class Person
-				attr_accessor :name
-			end
+== Installation:
 
-		>> Person
-		=> Person
-		>> p = Person.new
-		>> p.name = "Tom"
-		>> p.name
-		=> "Tom"
-
-
-		>> "a
-		b"
-		=> "a\nb"
-
-		>> 1 +
-		?> 2
-		=> 3
-
-== INSTALL:
-
 Major releases:
 
 	sudo gem install rubydoctest
 
 Build from source:
 
 	git clone git://github.com/tablatom/rubydoctest.git
 	cd rubydoctest
-	rake manifest && rake install
+	rake manifest:refresh && rake install
 
-== SELF-DOCTESTING:
+== Testing DocTest:
 	
 Ruby DocTest uses itself to test and document itself.
 
 	rake test:doctest
 	
 In development of Ruby DocTest, there is an autotest system in-built
 using script/rstakeout
 
 	rake test:doctest:auto
 
-== TEXTMATE BUNDLE:
+== TextMate Bundle:
 	
 See http://github.com/drnic/ruby-doctest-tmbundle
 
-== LICENSE:
+== License:
 
 (The MIT License)
 
-Copyright (c) 2008 FIX
+Copyright (c) 2008 Tom Locke, Nic Williams, Duane Johnson
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file