Here it is:
diff --git a/README.rdoc b/README.rdoc
index 2ff9aa6..b15475f 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,11 +1,5 @@
= bookinggit
-Describe your project here
-
-:include:bookinggit.rdoc
-
-# BOOKINGIT
-
A basic publishing system that takes Mardown and a Git repository and produces a readable "book" in the following forms:
* Website
@@ -14,17 +8,17 @@ A basic publishing system that takes Mardown and a Git repository and produces a
The idea is to easily show the evolution of code over the course of the book, based entirely on git diffs and pull requests.
-## Example
+== Example
-```
-Here is how our controller looks currently:
- git:///app/controlleres/users_controller.rb#initial-version
+ Here is how our controller looks currently:
+
+ git:///app/controlleres/users_controller.rb#initial-version
+
+ We'd like to change the mailer call to use Resque
-We'd like to change the mailer call to use Resque
+ git-diff:///app/controllers/users_controller.rb#add-resque-to-controller
- git-diff:///app/controllers/users_controller.rb#add-resque-to-controller
-```
This bit of Markdown could then be translated into Git-Hub Flavored Markdown like so:
@@ -83,11 +77,11 @@ When we generate the output, would actually run the tests and replace that with
```
-## Next Steps
+== Next Steps
1. Markdown-to-Markdown to insert a referenced file
-1. Markdown-to-Markdown to insert a referenced file from a specific git repo and SHA1
-1. Markdown-to-Markdown to insert a diff
-1. Markdown-to-Markdown to insert output of a shell command
+2. Markdown-to-Markdown to insert a referenced file from a specific git repo and SHA1
+3. Markdown-to-Markdown to insert a diff
+4. Markdown-to-Markdown to insert output of a shell command
Once these four steps are done, we can think about the larger structure and how that affects the output