Updated documentation

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@196 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 43 insertions, 1 deletions

diff --git a/railties/README b/railties/README
index 4d58c3276c..2c1c9a872d 100644
--- a/railties/README
+++ b/railties/README
@@ -41,7 +41,7 @@ link:files/vendor/actionpack/README.html.
 1. Run the WEBrick servlet: <tt>ruby script/server</tt>
    (run with --help for options)
 2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!"
-3. Follow the guidelines on the "Congratulations, you're on Rails!" screen
+3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen
 
 
 == Example for Apache conf
@@ -73,6 +73,48 @@ information to these files. Debugging info will also be shown in the browser
 on requests from 127.0.0.1.
 
 
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find_all
+      breakpoint "Breaking out from the list"
+    end
+  end
+  
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, 
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first 
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through script/console. 
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Start the script without arguments to see the options.
+
+
 == Description of contents
 
 app