Cleaned up the README.markdown and closed the bug

Author: Ben Brinckerhoff

README.markdown

@@ -33,7 +33,7 @@ USAGE
 
 To use Construct, you need to include the Construct module in your class like so:
 
-    include Construct
+    include Construct::Helpers
 
 Using construct is as simple as calling `within_construct` and providing a block. All files and directories that are created within that block are created within a temporary directory. The temporary directory is always deleted before `within_construct` finishes.
 
@@ -44,76 +44,81 @@ Creating files
 
 The most basic use of Construct is creating an empty file with the:
 
-   within_construct do |construct|
-     construct.file('foo.txt')
-   end
+    within_construct do |construct|
+      construct.file('foo.txt')
+    end
 
 Note that the working directory is, by default, automatically change to the temporary directory created by Construct, so the following assertion will pass:
 
-   within_construct do |construct|
-     construct.file('foo.txt')
-     assert File.exist?('foo.txt')
-   end
+    within_construct do |construct|
+      construct.file('foo.txt')
+      assert File.exist?('foo.txt')
+    end
 
 You can also provide content for the file, either with an optional argument or using the return value of a supplied block:
 
-   within_construct do |construct|
-     construct.file('foo.txt','Here is some content')
-     construct.file('bar.txt') do
-     <<-EOS
-     The block will return this string, which will be used as the content.
-     EOS
-     end
-   end
+    within_construct do |construct|
+      construct.file('foo.txt','Here is some content')
+      construct.file('bar.txt') do
+      <<-EOS
+      The block will return this string, which will be used as the content.
+      EOS
+      end
+    end
 
 If you provide block that accepts a parameter, construct will pass you the IO object. In this case, you are responsible for writing content to the file yourself - the return value of the block will not be used:
 
-   within_construct do |construct|
-     construct.file('foo.txt') do |file|
-       file << "Some content\n"
-       file << "Some more content"
-     end
-   end
+    within_construct do |construct|
+      construct.file('foo.txt') do |file|
+        file << "Some content\n"
+        file << "Some more content"
+      end
+    end
 
 Finally, you can provide the entire path to a file and the parent directories will be created automatically:
 
-   within_construct do |construct|
-     construct.file('foo/bar/baz.txt')
-   end
+    within_construct do |construct|
+      construct.file('foo/bar/baz.txt')
+    end
 
 Creating directories
 --------------
 
 It is easy to create a directory:
 
-   within_construct do |construct|
-     construct.directory('foo')
-   end
+    within_construct do |construct|
+      construct.directory('foo')
+    end
+
+You can also provide a block. The object passed to the block can be used to create nested files and directories (it's just a [Pathname](http://www.ruby-doc.org/stdlib/libdoc/pathname/rdoc/index.html) instance with some extra functionality, so you can use it to get the path of the current directory).
 
-You can also provide a block. The object passed to the block can be used to create nested files and directories. Again, note that the working directory is automatically changed while in the block:
+Again, note that the working directory is automatically changed while in the block:
 
-   within_construct do |construct|
-     construct.directory('foo') do |dir|
-       dir.file('bar.txt')
-       assert File.exist?('bar.txt') # This assertion will pass
-     end
-   end
+    within_construct do |construct|
+      construct.directory('foo') do |dir|
+        dir.file('bar.txt')
+        assert File.exist?('bar.txt') # This assertion will pass
+      end
+    end
 
 Again, you can provide paths and the necessary directories will be automatically created:
 
-   within_construct do |construct|
-     construct.directory('foo/bar/') do |dir|
-       dir.directory('baz')
-       dir.directory('bazz')
-     end
-   end
+    within_construct do |construct|
+      construct.directory('foo/bar/') do |dir|
+        dir.directory('baz')
+        dir.directory('bazz')
+      end
+    end
 
+Please read test/construct_test.rb for more examples.
 
-== INSTALL:
+INSTALL
+=======
 
 gem install devver-construct --source http://gems.github.com
 
-== LICENSE:
+LICENSE
+=======
 
 (The MIT License)
 

bugs/issue-881ae950569b6ca718fae0060f2751710b972fd2.yaml

@@ -5,8 +5,8 @@ type: :task
 component: construct
 release: neo
 reporter: Benjamin Brinckerhoff <[email protected]>
-status: :unstarted
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2009-08-18 17:19:03.766097 Z
 references: []
 
@@ -16,3 +16,7 @@ log_events:
   - Benjamin Brinckerhoff <[email protected]>
   - created
   - ""
+- - 2009-08-18 20:15:40.057331 Z
+  - Benjamin Brinckerhoff <[email protected]>
+  - closed with disposition fixed
+  - ""