Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ainsleyclark
ainsleyclark committed May 9, 2022
1 parent f6158f4 commit f8d82e2
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,17 @@ process screenshots. Credits to [Pageres](https://github.com/sindresorhus/pagere

## Examples

Snap a URL with a size of `1920x1080`

```
/snap?url=https://google.com&size=1920x1080
```


Snap a URL with the height set (crop) and serve the images fresh (no cache).

```
/snap?url=https://google.com
/snap?url=https://google.com&size=1920x1080&ignoreCache=true
```

## Options
Expand All @@ -37,7 +46,7 @@ Below are the options represented as query parameters you can pass to the `/snap
| ignoreCache | `false` | | If the cache should be ignored when processing the screenshot. |
| rebuildCache | `false` | | If the cache is to be rebuilt. |
| delay | `false` | | Delay capturing the screenshot. Useful when the site does things after load that you want to capture. |
| crop | `true` | | Delay capturing the screenshot. Useful when the site does things after load that you want to capture. |
| crop | `true` | | Crop to the set height. |
| css | | | Apply custom CSS to the webpage. |
| script | | | Apply custom JavaScript to the webpage. |
| selector | | | Capture a specific DOM element matching a CSS selector. |
Expand Down

0 comments on commit f8d82e2

Please sign in to comment.