README.md in snapshot-0.3.2 vs README.md in snapshot-0.3.3
- old
+ new
@@ -1,18 +1,19 @@
<p align="center">
<a href="https://github.com/KrauseFx/deliver">Deliver</a> •
<b>Snapshot</b> •
<a href="https://github.com/KrauseFx/frameit">FrameIt</a> •
-<a href="https://github.com/KrauseFx/PEM">PEM</a>
+<a href="https://github.com/KrauseFx/PEM">PEM</a> •
+<a href="https://github.com/KrauseFx/sigh">Sigh</a>
</p>
-------
<p align="center">
<img src="assets/snapshot.png">
</p>
-Snapshot - Create hundreds of iOS app screenshots
+Snapshot - Create iOS App Screenshots
============
[](https://twitter.com/KrauseFx)
[](https://github.com/KrauseFx/snapshot/blob/master/LICENSE)
[](http://rubygems.org/gems/snapshot)
@@ -39,26 +40,29 @@
Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
-------
-[Features](#features) •
-[Installation](#installation) •
-[UI Automation](#ui-automation) •
-[Quick Start](#quick-start) •
-[Usage](#usage) •
-[Tips](#tips) •
-[Need help?](#need-help)
+<p align="center">
+ <a href="#features">Features</a> •
+ <a href="#installation">Installation</a> •
+ <a href="#ui-automation">UI Automation</a> •
+ <a href="#quick-start">Quick Start</a> •
+ <a href="#usage">Usage</a> •
+ <a href="#tips">Tips</a> •
+ <a href="#need-help">Need help?</a>
+</p>
-------
# Features
- Create hundreds of screenshots in multiple languages on all simulators
- Configure it once, store the configuration in git
- Do something else, while the computer takes the screenshots for you
-- Very easy to integrate with ```deliver```
+- Very easy to integrate with [```deliver```](https://github.com/KrauseFx/deliver)
+- Generates a beautiful web page, which shows all screenshots on all devices. This is perfect to send to Q&A or the marketing team
- ```Snapshot``` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
After ```Snapshot``` successfully created new screenshots, it will generate a beautiful html file to get a quick overview of all screens:
@@ -182,16 +186,10 @@
By default, ```snapshot``` will look for your project in the current directory. If it is located somewhere else, pass your custom path:
```ruby
project_path "./my_project/Project.xcworkspace"
```
-### HTML Report Path
-After all screenshots were created, a HTML file will be generated, to quickly get an overview of all screens on all devices. You can set a custom export path, to easily integrate the HTML report as ```Jenkins``` test result page.
-```ruby
-html_path "~/Desktop/screens.html"
-```
-
### iOS Version
I'll try to keep the script up to date. If you need to change the iOS version, you can do it like this:
```ruby
ios_version "9.0"
@@ -236,9 +234,17 @@
### Skip alpha removal from screenshots
In case you want to skip this process, just add ```skip_alpha_removal``` to your ```Snapfile```.
# Tips
+
+## Other helpful tools
+Check out other tools in this collection to speed up your deployment process:
+- [```deliver```](https://github.com/KrauseFx/deliver): Deploy screenshots, app metadata and app updates to the App Store using just one command.
+- [```FrameIt```](https://github.com/KrauseFx/frameit): Want a device frame around your screenshot? Do it in an instant!
+- [```PEM```](https://github.com/KrauseFx/pem): Tired of manually creating and maintaining your push certification profiles?
+- [```sigh```](https://github.com/KrauseFx/sigh): Because you would rather spend your time building stuff than fighting provisioning.
+
## Specify a custom ```Snapfile```
snapshot --snapfile ./SpecialSnapfile
Be aware: The file will be executed from the current directory, not the location of the ```Snapfile```. That means: ```./screenshots``` will export the screenshots to the current directory of your terminal session.