Skip to content
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.

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

📝 Update snapshot options docs in README #354

Merged
merged 1 commit into from
Jul 30, 2021
Merged
Changes from all commits
Commits
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
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,7 @@ $ percy exec -- ember test
`percySnapshot(name[, options])`

- `name` (**required**) - The snapshot name; must be unique to each snapshot
- `options` - Additional snapshot options (overrides any project options)
- `options.widths` - An array of widths to take screenshots at
- `options.minHeight` - The minimum viewport height to take screenshots at
- `options.percyCSS` - Percy specific CSS only applied in Percy's rendering environment
- `options.requestHeaders` - Headers that should be used during asset discovery
- `options.enableJavaScript` - Enable JavaScript in Percy's rendering environment
- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)

### Automatic snapshot names

Expand Down