snapshot 0.10.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 230b09323b14d87bc36bbf259a2ef16dd289d1bf
-  data.tar.gz: 77bc0f09b874f94fbe96c009d9df63c4ae0d168d
+  metadata.gz: 381f0307803a2986ffa1180564d412ef8b01fc98
+  data.tar.gz: 32ea6efaca1869852332c6c604615b8e368a6d9e
 SHA512:
-  metadata.gz: 1939c18fd01c6d25cd9d6d6e94d6044583fe5d7f1dcc27ef0ec25e9184235f98aebaccf9403e6f87e688767f0f8dd5d64b973847ec350e1b6625592ee356c132
-  data.tar.gz: d9957883a6ec0c847239f9dade7f287cd87f078d7cb6b778fbe63e1901daff9f7c40a69175d605b656dca87215f1edddcaf5187eb01686e8bc3b0d462f746db7
+  metadata.gz: 625796bbb9c58d0c0f6d3d432420d41356b1e2911df7d86484c0763e6eb20ff82c84a586edde06d6117e37d31da898ae1bc349d6b7a67cb148b3e83d436de143
+  data.tar.gz: 74696231f888a4895b614fb621fa93e7912e506889f3c8ef4f721dbffe45d821642e7b6377d60489874556cee88a645125a272ffdf2f4c99300118fc9b4788d7

data/README.md

@@ -11,18 +11,18 @@
   <a href="https://github.com/KrauseFx/frameit">frameit</a> &bull; 
   <a href="https://github.com/KrauseFx/PEM">PEM</a> &bull; 
   <a href="https://github.com/KrauseFx/sigh">sigh</a> &bull; 
-  <a href="https://github.com/KrauseFx/produce">produce</a> &bull; 
-  <a href="https://github.com/KrauseFx/cert">cert</a> &bull; 
-  <a href="https://github.com/KrauseFx/codes">codes</a> &bull;
+  <a href="https://github.com/KrauseFx/produce">produce</a> &bull;
+  <a href="https://github.com/KrauseFx/cert">cert</a> &bull;
   <a href="https://github.com/fastlane/spaceship">spaceship</a> &bull;
   <a href="https://github.com/fastlane/pilot">pilot</a> &bull;
   <a href="https://github.com/fastlane/boarding">boarding</a> &bull;
-  <a href="https://github.com/fastlane/gym">gym</a>
+  <a href="https://github.com/fastlane/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/scan">scan</a>
 </p>
 -------
 
 <p align="center">
-    <img src="assets/snapshot.png">
+  <img src="assets/snapshot.png" height="110">
 </p>
 
 snapshot
@@ -34,13 +34,6 @@ snapshot
 
 ###### Automate taking localized screenshots of your iOS app on every device
 
-You have an iPhone app. You support 20 languages. You updated the design. You want to release the update to the App Store.
-What's missing?
-
-**New Screenshots**
-
-You want them to look **perfect** and **gorgeous**. They should show the same screens on all devices in all languages.
-
 You have to manually create 20 (languages) x 5 (devices) x 5 (screenshots) = **500 screenshots**.
 
 It's hard to get everything right!
@@ -49,19 +42,21 @@ It's hard to get everything right!
 - No loading indicators
 - Same content / screens
 - [Clean Status Bar](#use-a-clean-status-bar)
-- Uploading screenshots ([```deliver```](https://github.com/KrauseFx/deliver) is your friend)
+- Uploading screenshots ([`deliver`](https://github.com/KrauseFx/deliver) is your friend)
 
-This gem solves all those problems. It will run completely in the background - you can do something else, while your computer takes the screenshots for you.
+More information about [creating perfect screenshots](https://krausefx.com/blog/creating-perfect-app-store-screenshots-of-your-ios-app).
+
+`snapshot` runs completely in the background - you can do something else, while your computer takes the screenshots for you.
 
 Get in contact with the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
 
-### Note: Support for UI Tests with Xcode 7
+### Note: New `snapshot` with UI Tests in Xcode 7
 
-Apple announced a new version of Xcode with support for UI Tests built in right into Xcode. This technology allows `snapshot` to be even better: Instead of dealing with UI Automation Javascript code, you will be able to write the screenshot code in Swift or Objective C allowing you to use debugging features like breakpoints.
+Apple announced a new version of Xcode with support for UI Tests built in right into Xcode. This technology allows `snapshot` to be even better: Instead of dealing with UI Automation Javascript code, you are now be able to write the screenshot code in Swift or Objective C allowing you to use debugging features like breakpoints.
 
-It's still work in progress and there are some technical difficulties I need to solve. 
+As a result, `snapshot` was completely rewritten from ground up without changing its public API.
 
-As a result, `snapshot` will be completely rewritten from ground up without changing its public API :rocket:
+Please check out the [MigrationGuide to 1.0](/MigrationGuide.md) :+1:
 
 **Why change to UI Tests?**
 
@@ -75,10 +70,11 @@ As a result, `snapshot` will be completely rewritten from ground up without chan
 <p align="center">
     <a href="#features">Features</a> &bull; 
     <a href="#installation">Installation</a> &bull; 
-    <a href="#ui-automation">UI Automation</a> &bull; 
+    <a href="#ui-tests">UI Tests</a> &bull; 
     <a href="#quick-start">Quick Start</a> &bull; 
     <a href="#usage">Usage</a> &bull; 
     <a href="#tips">Tips</a> &bull; 
+    <a href="#how-does-it-work">How?</a> &bull; 
     <a href="#need-help">Need help?</a>
 </p>
 
@@ -86,42 +82,33 @@ As a result, `snapshot` will be completely rewritten from ground up without chan
 
 <h5 align="center"><code>snapshot</code> is part of <a href="https://fastlane.tools">fastlane</a>: connect all deployment tools into one streamlined workflow.</h5>
 
-
-
 # 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
 - Integrates with [`fastlane`](https://fastlane.tools) and [`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)
-- Support for advanced configuration, like preprocess macros or [prefilling of data](#prefilling)
+- `snapshot` automatically waits for network requests to be finished before taking a screenshot (we don't want loading images in the App Store screenshots)
 
 ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
 
-After ```snapshot``` successfully created new screenshots, it will generate a beautiful html file to get a quick overview of all screens:
+After `snapshot` successfully created new screenshots, it will generate a beautiful HTML file to get a quick overview of all screens:
 
 ![assets/htmlPagePreviewFade.jpg](assets/htmlPagePreviewFade.jpg)
 
 ## Why?
-This gem automatically switches the language and device type and runs the automation script to take all screenshots.
+
+This tool automatically switches the language and device type and runs UI Tests for every combination.
 
 ### Why should I automate this process?
+
 - It takes **hours** to take screenshots
+- You get a great overview of all your screens, running on all available simulators without the need to manually start it hundreds of times
+- Easy verification for translators (without an iDevice) that translations do make sense in real App context
+- Easy verification that localizations fit into labels on all screen dimensions
 - It is an integration test: You can test for UI elements and other things inside your scripts
 - Be so nice, and provide new screenshots with every App Store update. Your customers deserve it
 - You realise, there is a spelling mistake in one of the screens? Well, just correct it and re-run the script
-- You get a great overview of all your screens, running on all available simulators without the need to manually start it hundreds of times
-- Easy verification that localizations fit into labels on all screen dimensions
-- Easy verification for translators (without an iDevice) that translations do make sense in real App context
-
-###Why use ```snapshot``` instead of....
-
-I've been using many other solutions out there. Unfortunately none of them were perfect. The biggest issue was random timeouts of ```Instruments``` when starting the script. This problem is solved with ```snapshot```
-
-- **UI Automation in Instruments**: Instruments can only run your app on one device in one language. You have to manually switch it.
-- **[ui-screen-shooter](https://github.com/jonathanpenn/ui-screen-shooter)**: This is the best alternative out there right now. It's based on AppleScript, you can not update it properly and there are quite some hacks in there. ```snapshot``` uses a very similar technique - just in a clean and maintainable Ruby gem.
-- **[Subliminal](https://github.com/inkling/Subliminal)**: A good approach to write the interaction code in Objective C. Unfortunately the project seems to be dead and doesn't work with the latest version of Xcode yet. Also, it requires modifications of your Xcode project and schemes, which might break some other things.
 
 # Installation
 
@@ -133,234 +120,134 @@ Make sure, you have the latest version of the Xcode command line tools installed
 
     xcode-select --install
     
-# UI Automation
+# UI Tests
 
 ## Getting started
-This project uses Apple's ```UI Automation``` under the hood. I will not go into detail on how to write scripts. 
+This project uses Apple's newly announced UI Tests. I will not go into detail on how to write scripts. 
 
 Here a few links to get started:
 
-- [Apple's official documentation](https://developer.apple.com/library/ios/documentation/DeveloperTools/Conceptual/InstrumentsUserGuide/UsingtheAutomationInstrument/UsingtheAutomationInstrument.html)
-- [UI Automation: An Introduction (cocoamanifest.net)](http://cocoamanifest.net/articles/2011/05/uiautomation-an-introduction.html)
-- [Functional Testing UI Automation (mattmccomb.com)](http://www.mattmccomb.com/blog/2013/06/02/ios-functional-testing-with-uiautomation/)
-- [Cheat and use NSNotifications with HSUIAutomationCheat (github.com)](https://github.com/ConfusedVorlon/HSUIAutomationCheat)
+- [WWDC 2015 Introduction to UI Tests](https://developer.apple.com/videos/play/wwdc2015-406/)
+- [A first look into UI Tests](http://www.mokacoding.com/blog/xcode-7-ui-testing/)
+- [UI Testing in Xcode 7](http://masilotti.com/ui-testing-xcode-7/)
+
+**Note**: Since there is no official way to trigger a screenshot from UI Tests, `snapshot` uses a workaround (described in [How Does It Work?](#how-does-it-work)) to trigger a screenshot. If you feel like this should be done right, please duplicate radar [23062925](https://openradar.appspot.com/radar?id=5056366381105152).
 
 # Quick Start
 
-- Run ```snapshot init``` in your project folder
-- Profile your app in Xcode (CMD + I), choose ```Automation``` and click the Record button on the bottom of the window.
-- This will get you started. Copy the generated code into ```./snapshot.js```. Make sure, you leave the import statement on the top.
-- To take a screenshot, use ```captureLocalizedScreenshot('0-name')```
+- Create a new UI Test target in your Xcode project ([top part of this article](https://krausefx.com/blog/run-xcode-7-ui-tests-from-the-command-line))
+- Run `snapshot init` in your project folder
+- Add the ./SnapshotHelper.swift to your UI Test target (You can move the file anywhere you want)
+- In your UI Test class, click the `Record` button on the bottom left and record your interaction
+- Add `snapshot("01LoginScreen")` method calls inbetween your interactions to take new screenshots
+- Add the following code to your `setUp()` method
+
+```swift
+let app = XCUIApplication()
+setLanguage(app)
+app.launch()
+```
 
-Here is a nice gif, that shows ```snapshot``` in action:
 ![assets/snapshot.gif](assets/snapshot.gif)
 
 You can take a look at the example project to play around with it.
 
-## Start ```snapshot```
-
-- ```cd [your_project_folder]```
-- ```snapshot```
-
-Your screenshots will be stored in ```./screenshots/``` by default.
-
-From now on, you can run ```snapshot``` to create new screenshots of your app.
-
-
 # Usage
 
-```
+```sh
 snapshot
 ```
 
-To skip cleaning the project:
-```
-snapshot --noclean
-```
-
-To only run tests (i.e. don't actually take any screenshots):
-```
-snapshot test
-```
-
+Your screenshots will be stored in the `./screenshots/` folder by default (or `./fastlane/screenshots` if you're using [fastlane](https://fastlane.tools))
 
 If any error occurs while running the snapshot script on a device, that device will not have any screenshots, and `snapshot` will continue with the next device or language. To stop the flow after the first error, run
 
-```
-SNAPSHOT_BREAK_ON_FIRST_ERROR=1 snapshot
-```
-
+Also by default, `snapshot` will open the HTML after all is done. This can be skipped with the following command
 
-By default, `snapshot` will re-install the app, to make sure it's in a clean state. In case you don't want this run
 
-```
-SNAPSHOT_SKIP_UNINSTALL=1 snapshot
+```sh
+snapshot --stop_after_first_error --skip_open_summary
 ```
 
+There are a lot of options available that define how to build your app, for example
 
-Also by default, `snapshot` will open the HTML after all is done. This can be skipped with the following command
+```sh
+snapshot --scheme "UITests" --configuration "Release"  --sdk "iphonesimulator"
+``` 
 
-```
-SNAPSHOT_SKIP_OPEN_SUMMARY=1 snapshot
+For a list for all available options run
+
+```sh
+snapshot --help
 ```
 
 ## Snapfile
 
-#### Why should you have to remember complicated commands and parameters?
+All of the available options can also be stored in a configuration file called the `Snapfile`. Since most values will not change often for your project, it is recommended to store them there:
 
-Store your configuration in a text file to easily take screenshots from any computer.
+First make sure to have a `Snapfile` (you get it for free when running `snapshot init`)
 
-Create a file called ```Snapfile``` in your project directory.
-Once you created your configuration, just run ```snapshot```.
+The `Snapfile` can contain all the options that are also available on `snapshot --help`
 
-The ```Snapfile``` may contain the following information (all are optional):
 
-### Simulator Types
 ```ruby
+scheme "UITests"
+
 devices([
   "iPhone 6",
   "iPhone 6 Plus",
   "iPhone 5",
-  "iPhone 4s",
-  "iPad Air"
+  "iPhone 4s"
 ])
-```
-
-### Languages
 
-```ruby
 languages([
   "en-US",
   "de-DE",
-  "es-ES",
-  ["cmn-Hans", "cmn-Hans_CN"] # you can specify a locale if needed
+  "es-ES"
 ])
-```
-
-### JavaScript file
-Usually ```snapshot``` automatically finds your JavaScript file. If that's not the case, you can pass the path 
-to your test file.
-```ruby
-js_file './path/file.js'
-```
-
-You can add a custom script for iPads: `./path/file-iPad.js` and it will automatically be used if found. Just append the `-iPad` to your existing file.
-
-If you want to overwrite the JS path using environment variables, use `SNAPSHOT_JS_FILE`.
-
-### Scheme
-To not be asked which scheme to use, just set it like this:
-```ruby
-scheme "Name"
-```
-You can also use the environment variable ```SNAPSHOT_SCHEME```.
 
-### Screenshots output path
-All generated screenshots will be stored in the given path.
-```ruby
-screenshots_path './screenshots'
-```
-You can also use the environment variable ```SNAPSHOT_SCREENSHOTS_PATH```.
+# The directory in which the screenshots should be stored
+output_directory './screenshots'
 
-### Project Path
-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"
-```
-
-### 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"
+clear_previous_screenshots true
 ```
 
-### HTML Title
-
-If you want to change the title of the generated HTML page, you can use:
-
-```ruby
-html_title 'Example'
-```
-
-### Custom Args for the build command
-Use the ```custom_args``` directive to prepend custom statements to the build command.
-
-Add a ```custom_build_args``` line to your ```Snapfile``` to add custom arguments to the build command.
-
-Here is an example for adding a preprocessor macro `SNAPSHOT`:
-
-```ruby
-custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1'"
-```
+### Completely reset all simulators
 
-In your Objective-C code, use the following code to detect the `snapshot` mode:
+You can run this command in the terminal to delete and re-create all iOS simulators:
 
-```objective-c
-#ifdef SNAPSHOT
-// Your Code here
-#endif
 ```
-
-### Custom Args for the run command
-Add a ```custom_run_args``` line to your ```Snapfile``` to add custom arguments to the run command (i.e. the invocation of `instruments`. You can use this to set the value of a specific `NSUserDefaults` key, for example
-
-```ruby
-custom_run_args "-DidViewOnboarding YES"
+snapshot reset_simulators
 ```
 
-### Custom Build Command
-If for some reason, the default build command does not work for your project, you can pass your own build script. The script will be executed **once** before the tests are being run.
-
-**Make sure** you are setting the output path to ```/tmp/snapshot``` or specify a custom ```build_dir``` on your ```Snapfile```.
-
-```ruby
-build_command "xcodebuild DSTROOT='/tmp/snapshot' OBJROOT='/tmp/snapshot' SYMROOT='/tmp/snapshot' ... "
-```
+**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird `Instruments` problems when running `snapshot`. 
 
-### Custom callbacks to prepare your app
-Run your own script when ```snapshot``` switches the simulator type or the language.
-This can be used to
-- Logout the user
-- Reset all user defaults
-- Pre-fill the database
+You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for confirmation before deleting.
 
-The `setup_for_device_change` will be called **before** the app is installed on the simulator.
+# How does it work?
 
-To run a shell script, just use ```system('./script.sh')```.
-```ruby
-setup_for_device_change do |device, udid, language|
-  puts "Running #{language} on #{device}"
-  system("./populateDatabase.sh")
-end
-
-teardown_device do |language, device|
-  puts "Finished with #{language} on #{device}"
-  system("./cleanup.sh")
-end
-```
+The easiest solution would be to just render the UIWindow into a file. That's not possible because UI Tests don't run on a main thread. So `snapshot` uses a different approach:
 
-### Skip alpha removal from screenshots
-In case you want to skip this process, just add ```skip_alpha_removal``` to your ```Snapfile```.
+When you run unit tests in Xcode, the reporter generates a plist file, documenting all events that occured during the tests ([More Information](http://michele.io/test-logs-in-xcode)). Additionally, Xcode generates screenshots before, duing and after each of these events. There seems to be no way to manually trigger a screenshot event. The screenshots and the plist files are stored in the DerivedData directory, which `snapshot` stores in a temporary folder.
 
-### Clear old screenshots
+When the user calls `snapshot(...)` in the UI Tests (Swift or Objective C) the script actually just does a swipe gesture outside of the screen bounds which doesn't make any sense. It has no effect to the application and is not something you would do in your tests. The goal was to find *some* event that a user would never trigger, so that we know it's from `snapshot`.
 
-If you add this line in your `Snapfile`, the previously generated screenshots will be deleted before generating new ones:
+`snapshot` then iterates through all test events and check where we did this weird gesture. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application. 
 
-```ruby
-clear_previous_screenshots
-```
+In the test output, the Swift `snapshot` function will print out something like this
 
-### Completely reset all simulators
+  snapshot: [some random text here]
 
-You can run this command in the terminal to delete and re-create all iOS simulators:
+`snapshot` finds all these entries using a regex. The number of `snapshot` outputs in the terminal and the number of `snapshot` events in the plist file should be the same. Knowing that, `snapshot` automatically matches these 2 lists to identify the name of each of these screenshots. They are then copied over to the output directory and separated by language and device.
 
-    snapshot reset_simulators
+2 thing have to be passed on from `snapshot` to the `xcodebuild` command line tool:
 
-**Warning**: This will delete **all** your simulators and replace by new ones! This is useful, if you run into weird `Instruments` problems when running `snapshot`. 
+- The device type is passed via the `destination` parameter of the `xcodebuild` parameter
+- The language is passed via a temporary file which is written by `snapshot` before running the tests and read by the UI Tests when launching the application
 
-You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for confirmation before deleting.
+If you find a better way to do any of this, please submit an issue on GitHub or even a pull request :+1:
 
+Also, feel free to duplicate radar [23062925](https://openradar.appspot.com/radar?id=5056366381105152).
 
 # Tips
 
@@ -373,11 +260,11 @@ You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for
 - [`sigh`](https://github.com/KrauseFx/sigh): Because you would rather spend your time building stuff than fighting provisioning
 - [`produce`](https://github.com/KrauseFx/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
 - [`cert`](https://github.com/KrauseFx/cert): Automatically create and maintain iOS code signing certificates
-- [`codes`](https://github.com/KrauseFx/codes): Create promo codes for iOS Apps using the command line
 - [`spaceship`](https://github.com/fastlane/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
 - [`pilot`](https://github.com/fastlane/pilot): The best way to manage your TestFlight testers and builds from your terminal
 - [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers 
 - [`gym`](https://github.com/fastlane/gym): Building your iOS apps has never been easier
+- [`scan`](https://github.com/fastlane/scan): The easiest way to run tests of your iOS and Mac app
 
 ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
 
@@ -385,98 +272,6 @@ You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for
 
 If you want to add frames around the screenshots and even put a title on top, check out [frameit](https://github.com/fastlane/frameit).
 
-## Prefilling
-
-Usually you want to mock your screenshot data to show the same content for all screenshots.
-
-There are 2 ways of doing this:
-
-#### Preprocessor macro
-Use the preprocessor macro `SNAPSHOT` to check if `snapshot` is currently running in your code. This enables you to add checks like this:
-
-```objective-c
-#ifdef SNAPSHOT
-// Your Code here
-#endif
-```
-
-Open your `Snapfile` and add `custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1'"` to it.
-
-#### By pre-filling data/documents in the bundle
-
-As used by [MindNode](https://github.com/fastlane/examples/blob/master/MindNode/Snapfile) you can fill your bundle after building with demo data using your `Snapfile` to use it on run-time.
-
-```ruby
-example_files = './ExampleDocuments'
-folder_name = "ExampleDocuments"
-
-setup_for_device_change do |device, udid, language|
-  # This will make sure, all example documents are installed on the simulator
-
-  puts "Copying example files to .app"
-
-  app_path = "/tmp/snapshot/build/MindNode.app/"
-
-  FileUtils.mkdir_p(File.join(app_path, folder_name))
-
-  Dir.glob(File.join(example_files, '*.mindnode')).each do |example_path|
-    puts "Copying '#{example_path}' to .app container"
-    FileUtils.cp_r(example_path, File.join(app_path, folder_name)) rescue nil # in case the file already exists
-  end
-end
-```
-
-This is simple Ruby that gets executed **after** the app was built and **before** it is installed on the simulator.
-
-In your `Objective-C` code you can now load the documents from your bundle and copy them over to your `Documents` folder (if necessary).
-
-```objective-c
-#ifdef SNAPSHOT
-/** This method will take care of copying over the example documents from the app's bundle into the `Documents` directory */
-+ (void)load
-{
-    static NSString *exampleFolderName = @"ExampleDocuments";
-    if ([[NSBundle mainBundle] pathForResource:exampleFolderName ofType:@""]) {
-        NSArray *filesToCopy = @[@"File1",
-                                 @"File2"];
-        NSString *documents = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
-        
-        for (NSString *currentFile in filesToCopy) {
-            NSString *from = [[NSBundle mainBundle] pathForResource:currentFile ofType:@"filetype" inDirectory:exampleFolderName];
-            if (from && documents) {
-                NSError *error = nil;
-                NSString *resultingFileName = [NSString stringWithFormat:@"%@.filetype", currentFile];
-                [[NSFileManager defaultManager] copyItemAtPath:from
-                                                        toPath:[documents stringByAppendingPathComponent:resultingFileName]
-                                                         error:&error];
-                
-                if (error) {
-                    NSLog(@"Error copying the example MindNode file: %@", error);
-                }
-            }
-        }
-    }
-}
-
-```
-
-## Run in Continuous Integration System
-If you want to run `snapshot` on your `Jenkins` machine (or any other CI-system), you might run into an `authorization` popup coming up.
-
-You can disable this dialog, running the following command:
-```
-security authorizationdb read system.privilege.taskport > /tmp/system.privilege.taskport.plist
-/usr/libexec/PlistBuddy -c "Set :allow-root true" /tmp/system.privilege.taskport.plist
-sudo security authorizationdb write system.privilege.taskport < /tmp/system.privilege.taskport.plist
-```
-I found this solution in the [`Subliminal` wiki](https://github.com/inkling/Subliminal/wiki/Continuous-Integration#faq).
-
-## 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.
-
 ## Available language codes
 ```ruby
 ALL_LANGUAGES = ["da", "de-DE", "el", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi", "fr-CA", "fr-FR", "id", "it", "ja", "ko", "ms", "nl", "no", "pt-BR", "pt-PT", "ru", "sv", "th", "tr", "vi", "zh-Hans", "zh-Hant"]
@@ -485,64 +280,28 @@ ALL_LANGUAGES = ["da", "de-DE", "el", "en-AU", "en-CA", "en-GB", "en-US", "es-ES
 ## Use a clean status bar
 You can use [SimulatorStatusMagic](https://github.com/shinydevelopment/SimulatorStatusMagic) to clean up the status bar.
 
-## Editing the ```Snapfile```
-Change syntax highlighting to *Ruby*.
-
-## Instruments is not responding
-Unfortunately ```Instruments``` sometimes decides, to not respond to anything. Which means, neither the ```Instruments``` application, nor the ```instruments``` command line work. Killing the process doesn't help.
-
-The only way to fix this, is a restart of the Mac. 
+If you enable a clean status bar, you have to remove the `waitForLoadingIndicatorToDisappear` from the `SnapshotHelper.swift` code, as it doesn't detect when the loading indicator disappears. 
 
-## Use a custom build system
-Using a build systems not based on Xcode –such as RubyMotion or Xamarin– is also possible.
-
-### RubyMotion
-
-Add to your ```Snapfile```:
-
-```ruby
-build_dir 'build/iPhoneSimulator-7.0-Development'
-build_command 'rake build:simulator'
-```
-
-### Xamarin
-
-Add to your ```Snapfile```:
-
-```ruby
-build_dir 'YourProject/bin/iPhoneSimulator'
-build_command '/Applications/Xamarin\ Studio.app/Contents/MacOS/mdtool -v build "--configuration:Debug|iPhoneSimulator" YourProject.sln'
-```
-
-Unfortunately, Xamarin command line tool is only available for Business Edition licenses. For Indie licenses you can build the app using Xamarin Studio and use the ```--nobuild``` option.
-
-### Skip building
-
-If building via command-line doesn't work for your project or you don't want to build every time, you can run the tool with ```snapshot --nobuild``` to skip the build process and use a pre-built ```.app``` under your ```build_dir```.
+## Editing the `Snapfile`
+Change syntax highlighting to *Ruby*.
 
 ### Simulator doesn't launch the application
 
 When the app dies directly after the application is launched there might be 2 problems
 
 - The simulator is somehow in a broken state and you need to re-create it. You can use `snapshot reset_simulators` to reset all simulators (this will remove all installed apps)
-- You haven't enabled the correct architectures. Make sure you have the same architectures as in the example project of this repository. 
-
-### Snapshot throws an `Instruments Usage Error: Timed out waiting for device to boot: ...` error 
-
-This can happen when you launch `fastlane` or `snapshot` inside of a tool like `tmux`. Thankfully, Chris Johnsen wrote a fix to help us out, which you can find [here](https://github.com/ChrisJohnsen/tmux-MacOSX-pasteboard). Just follow the instructions at his repository, and launching the Simulator from `tmux` will work!
+- A restart helps very often
 
-## Determine language in UI Automation script
+## Determine language
 
-To detect the currently used localization in your Javascript file, use the following code:
+To detect the currently used localization in your tests, use the following code:
 
 ```javascript
-var result = target.host().performTaskWithPathArgumentsTimeout("/usr/bin/printenv" , ["SNAPSHOT_LANGUAGE"], 5);
-var language = result.stdout.substring(0, result.stdout.length - 1);
+You can access the language using the `deviceLanguage` variable.
 ```
 
 # Need help?
-- If there is a technical problem with ```snapshot```, submit an issue.
-- I'm available for contract work - drop me an email: snapshot@krausefx.com
+Please submit an issue on GitHub and provide information about your setup
 
 # License
 This project is licensed under the terms of the MIT license. See the LICENSE file.