README.rdoc in ae-1.7.0 vs README.rdoc in ae-1.7.1

@@ -1,7 +1,11 @@
 = Assertive Expressive
 
+Author:: Thomas Sawyer
+License:: Apache 2.0
+
+
 == DESCRIPTION
 
 Assertive Expressive (AE) is an assertions framework
 intended for reuse by any TDD, BDD or similar system.
 
@@ -17,12 +21,16 @@
 * Eats it's own dog food.
 
 
 == RESOURCES
 
-* home: http://rubyworks.github.com/ae/
-* code: http://github.com/rubyworks/ae/
+* home: http://rubyworks.github.com/ae
+* code: http://github.com/rubyworks/ae
+* docs: http://wiki.github.com/rubyworks/ae/docs/qed
+* wiki: http://wiki.github.com/rubyworks/ae
+* bugs: http://github.com/rubyworks/ae/issues
+* mail: http://googlegroups.com/group/rubyworks-mailinglist
 
 
 == SYNOPSIS
 
 AE defines the method +assert+. It's is compatible with the method
@@ -80,29 +88,59 @@
 counts are correct, a little extra interfacing code may be necessary.
 
 Lucky for you AE has already done the leg work for the most common
 test frameworks:
 
-* require 'ae/adapters/testunit'
-* require 'ae/adapters/minitest'
-* require 'ae/adapters/rspec'
+  require 'ae/adapters/testunit'
+  require 'ae/adapters/minitest'
+  require 'ae/adapters/rspec'
 
-Note that Cucumber does not need an adapter.
+(Note that Cucumber does not need an adapter.)
 
+AE also includes a script that will automatically detect the current
+test framework by checking for the existence of their respective 
+namespace modules.
 
-== HOW TO INSTALL
+  require 'ae/adapter'
 
-=== Gem Installs
 
-AE releases it's gems via Gemcutter. If you don't have Gemcutter
-installed do:
+== NOMENCLATURE
 
-  $ gem install gemcutter
-  $ gem tumble
+With AE, defining assertions centers around the #assert method. So
+*assert* can be thought of as AE's primary _nomenclature_. However, variant
+nomenclatures have been popularized by other test frameworks, in particular
+*should* and *must*. If you prefer one of them terms, AE provides optional
+libraries that can loaded for utilizing them.
 
-Then you can install AE with:
+  require 'ae/should'
+  require 'ae/must'
 
+By loading one of these scripts (or both) into your test system (e.g. via a test
+helper script) you gain access to subjunctive terminology. See the API documentation
+for the Subjunctive module for details.
+
+
+== LEGACY
+
+To ease transition from TestUnit style assertion methods, AE provides
+a TestUnit legacy module.
+
+  require 'ae/legacy'
+
+This provides a module AE::Legacy::Assertions which is included in AE::World
+and can be mixed into your test environment to provide old-school assertion
+methods. E.g.
+
+  assert_equal(foo, bar, "it failed")
+
+
+== INSTALLATION
+
+=== Gem Installs
+
+Install AE in the usual fashion:
+
   $ gem install ae
 
 === Site Installs
 
 Local installation requires Setup.rb.
@@ -127,8 +165,10 @@
 
 Unless otherwise provided for by the originating author, this
 program is distributed under the terms of the Apache 2.0 license.
 See the Apache2.txt for details.
 
-Protions of this program may be copyrighted by others. See the 
+Portions of this program may be copyrighted by others. See the 
 NOTICE.rdoc file for details.
+
+AE is a Rubyworks[http://rubyworks.github.com] project.