Skip to content

Fix small issues in md layout #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix small issues in md layout #13

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec7f743
Fix small issues in md layout
May 31, 2018
28ca4a9
Merge branch 'master' into patch-1
arnaudlevy Sep 28, 2023
8a0193e
Merge branch 'master' into patch-1
arnaudlevy Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,16 @@ settings = {:username => "foo", :password => "foobar"}
client = Screenshot::Client.new(settings)
```

###API
### API

####Getting available os and browsers
#### Getting available os and browsers
Fetches all available browsers. [API info](http://www.browserstack.com/screenshots/api#list-os-browsers)

``` ruby
client.get_os_and_browsers #returns a hash
```

####Generating Screenshots
#### Generating Screenshots
Frame the config object according to the format given. [Format info](http://www.browserstack.com/screenshots/api#generate-screenshots)

Eg settings object:
Expand All @@ -67,7 +67,7 @@ params = {
```
`callback_url`, `win_res`, `mac_res`, `quality`, `wait_time`, `orientation` and `tunnel` being optional parameters.

#####For testing Local/Internal Server setup
##### For testing Local/Internal Server setup
* First setup local tunnel using the command line method as mentioned [here](http://www.browserstack.com/local-testing#setup)
* Pass `:tunnel => true` in the params object

Expand All @@ -79,7 +79,7 @@ A request id is returned when a valid request is made.
request_id = client.generate_screenshots params
```

####Checking/Polling the status of the request
#### Checking/Polling the status of the request
Use this method to check if the requested screenshots are complete.
``` ruby
client.screenshots_done? request_id #returns `true` or `false`
Expand All @@ -90,7 +90,7 @@ Or you can fetch the request state
client.screenshots_status request_id #returns `queue` or `processing` or `done`
```

####Fetching the response of the requested screenshots
#### Fetching the response of the requested screenshots
``` ruby
client.screenshots request_id
```
Expand Down