From 1b3b601902d6dc7c293476cb589296fa7f1e1716 Mon Sep 17 00:00:00 2001 From: Eric Kidd Date: Wed, 22 Apr 2009 08:07:22 -0400 Subject: [PATCH] README: Expand installation instructions --- README.rdoc | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.rdoc b/README.rdoc index 2a213ce..5412f7f 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,12 +1,23 @@ = sinatra-url-for sinatra-url-for can be used by a Sinatra application to -construct absolute paths and full URLs. For example: +construct absolute paths and full URLs. +To install it, run: + + sudo gem install emk-sinatra-url-for -s http://gems.github.com + +To include it in a Sinatra application, write: + + require 'rubygems' gem 'emk-sinatra-url-for' require 'sinatra/url_for' - # From within a request. +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" @@ -20,7 +31,8 @@ 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. +the right direction. If this gem fails to work correctly on your web +system, please feel free to submit patches and/or bug reports! == Copyright