From 1df339284203f8f6ed8dc600d9c4695c7d15e45c Mon Sep 17 00:00:00 2001 From: Eric Kidd Date: Wed, 22 Apr 2009 08:17:30 -0400 Subject: [PATCH] README: Edit for clarity --- README.rdoc | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.rdoc b/README.rdoc index 5412f7f..34f339e 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,7 +1,14 @@ = sinatra-url-for -sinatra-url-for can be used by a Sinatra application to -construct absolute paths and full URLs. +sinatra-url-for constructs absolute paths and full URLs for +handlers in a Sinatra application. Assuming that your application is +running on example.com, and that it has been mapped to +/myapp, you should be able call +url_for+ from within a +handler as follows: + + url_for "/" # Returns "/myapp/" + url_for "/foo" # Returns "/myapp/foo" + url_for "/foo", :full # Returns "http://example.com/myapp/foo" To install it, run: @@ -13,15 +20,6 @@ To include it in a Sinatra application, write: gem 'emk-sinatra-url-for' require 'sinatra/url_for' -Once this is done, you should be able to call +url_for+ from within a -request. Assuming that your application is running on -example.com, and that it has been mapped to -/myapp, you should get: - - url_for "/" # Returns "/myapp/" - url_for "/foo" # Returns "/myapp/foo" - url_for "/foo", :full # Returns "http://example.com/myapp/foo" - If you're subclassing Sinatra::Base, then you need to call helpers manually: @@ -31,7 +29,7 @@ If you're subclassing Sinatra::Base, then you need to call end Thanks to "cypher23" on #mephisto and the folks on #rack for pointing me in -the right direction. If this gem fails to work correctly on your web +the right direction. If this gem fails to work correctly on your system, please feel free to submit patches and/or bug reports! == Copyright