Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arunkjn committed Jul 20, 2013
1 parent 65a1763 commit 076fa83
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Expand Up @@ -9,23 +9,23 @@ Credit goes to @trevordixon for his awesome express like [router](https://gist.g
Usage
--------------

- Assuming that you have [phantomJs](https://github.com/ariya/phantomjs) installed
- Assuming that you have [phantomJs](https://github.com/ariya/phantomjs) installed

```sh
git clone https://github.com/arunkjn/screenshot-service.git
cd screenshot-service
phantomjs server.js "YOUR_PORT_HERE"
```
- A server will start on your specified port, 8000 is the default port used.
- You can send a POST request now to YOUR_IP:PORT with the following options and get back a base64 encoded png image
- A server will start on your specified port, 8000 is the default port used.
- You can send a POST request now to YOUR_IP:PORT with the following options and get back a base64 encoded png image

-url="some_url" This parameter is required
-timeout="timeout in milliseconds to allow the page to load" default 1000ms
-width="width of browser window" default 1366px
-height="height of browser window" default 768px
* *url* = "some_url" This parameter is required
* *timeout* = "timeout in milliseconds to allow the page to load" defaults to 1000ms
* *width* = "width of browser window" defaults to 1366px
* *height* = "height of browser window" defaults to 768px


License
-

MIT
MIT

0 comments on commit 076fa83

Please sign in to comment.