Skip to content

Commit

Permalink
readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
wout fierens committed Dec 1, 2011
1 parent 0ec5157 commit 2ce9a52
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.markdown
Expand Up @@ -53,37 +53,42 @@ To only get the image url:

Options are:

* **:size**<br>
**:size**<br>
This is a proportion bounding box.<br>
Thumbnails will be resized to fit within this box.<br>
default: 'ORIGINAL'<br>
examples:
+ :size => '500x500'
+ :size => 'ORIGINAL'

* **:thumbnail** (alias for :size)
site_image_tag url, :size => '500x500'

* **:browser_size**<br>
site_image_tag url, :size => 'ORIGINAL'

**:thumbnail** (alias for :size)

**:browser_size**<br>
Set the initial browser screen size.<br>
default: '1024x768'<br>
min: '200x200'<br>
max: '4000x4000'<br>
example:
+ :browser_size => '1024x2500'

site_image_tag url, :size => '300x200', :browser_size => '1024x2500'

* **:delay**<br>
**:delay**<br>
Extra delay (in seconds) forced between page load and screenshot.<br>
min: 1<br>
max: 5<br>
example:
+ :delay => 2

* **:fullscreen**<br>
site_image_tag url, :size => '300x200', :delay => 2

**:fullscreen**<br>
When true, Will attempt to capture entire document canvas.<br>
Will never return screenshot smaller than "Initial Screen Size".<br>
default: false<br>
example:
+ :fullscreen => true

site_image_tag url, :size => '300x200', :fullscreen => true


Original API docs: https://url2png.com/doc/
Expand Down

0 comments on commit 2ce9a52

Please sign in to comment.