README.md in nakal-0.0.2 vs README.md in nakal-0.0.3

- old
+ new

@@ -18,54 +18,49 @@ ## Usage If you are using cucumber, include following Lines in your env.rb -require "nakal/cucumber" + require "nakal/cucumber" + Nakal.platform = :android + Nakal.directory= "<your_project_dir>/baseline_images/droid" + Nakal.device_name = "samsung_galaxy_s3" -Nakal.platform = :android +and then put this line in your automation code, at all places where a new screen loads: -Nakal.directory= "baseline_images/droid" + diff = nakal_execute("current_screen_name") -Nakal.device_name = "samsung_galaxy_s3" +Now, execute your test by passing env variable NAKAL_MODE=build to build the baseline images -and then put this line in your code where you want comparison to begin: +once baseline is built, next execution onwards, start using environment variable NAKAL_MODE=compare to compare against baseline. +any difference will be put in the same directory with image file named "current_screen_name_diff.png" -diff = nakal_execute("current_screen_name") - -While executing first time, pass env variable NAKAL_MODE=build to build the baseline images - -once baseline is built, next execution onwards, start using environment variable NAKAL_MODE=compare to compare against baseline - - For cropping the notification bar OR scroll bar, create a config/nakal.yml file in execution directory eg: put these contents in your nakal.yml file inside config/nakal.yml -samsung_galaxy_s3: - - top: 50 - - right: 18 - - left: 0 - - bottom: 0 + samsung_galaxy_s3: + top: 50 + right: 18 + left: 0 + bottom: 0 -nexus7: - - top: 74 - - right: 20 - - left: 0 - - bottom: 0 + nexus7: + top: 74 + right: 20 + left: 0 + bottom: 0 - + iPhone_5s: + top: 30 + right: 6 + left: 0 + bottom: 0 + + ## Contributing 1. Fork it ( http://github.com/<my-github-username>/nakal/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`)