Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ainame committed Nov 24, 2021
1 parent eceb87b commit 540384e
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Or install it yourself as:

- [x] Allow for easy querying of test plan summaires
- [x] Allow for easy exporting of `.xccovreport` files
- [ ] Allow for exporting of screenshots
- [x] Allow for exporting of screenshots
- [ ] Add full documentation on all classes and methods
- [ ] Add more and better explain examples
- [ ] Add tests and improved code coverage
Expand All @@ -47,6 +47,13 @@ parser = XCResult::Parser.new(path: 'YourProject.xcresult')
summaries = parser.action_test_plan_summaries
```

### Export screenshots

```rb
parser = XCResult::Parser.new(path: 'YourProject.xcresult')
parser = parser.export_screenshots(destination: './screenshots', by_device: true, by_locale: true)
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down

0 comments on commit 540384e

Please sign in to comment.