README.rdoc in pdf-my-url-1.0.0 vs README.rdoc in pdf-my-url-1.0.1
- old
+ new
@@ -1,17 +1,29 @@
= PDFmyURL
-A basic ruby-on-rails interface to http://pdfmyurl.com/
+PDFmyURL is a basic ruby-on-rails view helper for the online web service http://pdfmyurl.com/. It allows for easy PDF creation from URLs without having to install any conversion tools.
+== Requirements
+
+The gem has only been tested with Ruby 1.9.2 and Rails 3.0.3 but may well work with other versions of Ruby or Rails.
+
+== Installation
+
+ gem install pdf-my-url
+
== Example
<%= pdf_my_url 'CBC', 'http://www.cbc.ca/' %>
+
+ <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :filename => 'CBC.pdf' %>
+
+ <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :orientation => :portrait %>
+
+ <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :orientation => :landscape %>
+
+ <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :page => { :height => 200, :width => 200 } %>
+
+ <%= pdf_my_url 'CBC', 'http://www.cbc.ca/', :margin => { :top => 10, :left => 5, :right => 5, :bottom => 10 } %>
- <%= pdf_my_url 'BBC', 'http://www.bbc.co.uk/', :filename => 'BBC.pdf' %>
-
- <%= pdf_my_url 'NY Times', 'http://www.nytimes.com/', :filename => 'NY-Times.pdf',
- :page_height => 200, :page_width => 100,
- :margin_top => 10, :margin_left => 5, :margin_right => 5, :margin_bottom => 10 %>
-
== Copyright
-Copyright (c) 2010 Kevin Sylvestre, released under the MIT license
+Copyright (c) 2010 Kevin Sylvestre. See LICENSE for details.