Merge pull request #1 from browserstack/restructure

Restructure

Author: tr4n2uil

.gitignore

@@ -1,3 +1,4 @@
 composer.lock
+local.log
 vendor/
 bin/

README.md

@@ -1,13 +1,47 @@
-phpunit-browserstack
-=========
+# PHPUnit-Browserstack
 
-This repository provides information and helpful tweaks to run your PhpUnit tests on the BrowserStack selenium cloud infrastructure.
+Run [PHPUnit](https://github.com/sebastianbergmann/phpunit) scripts on BrowserStack.
 
-You can run parallel as well as single test on the BrowserStack. Follow the steps in the respective folders for further information.
+## Usage
 
+### Prerequisites
+
+composer and php
+
+### Clone the repo
+
+`git clone https://github.com/browserstack/phpunit-browserstack.git`
+
+### Install dependencies
+
+Navigate to the root directory for testing and then install the dependencies by running
+
+`composer install`
+
+### BrowserStack Authentication
+
+Export the environment variables for the username and access key of your BrowserStack account.
+These can be found on the automate accounts page on [BrowserStack](https://www.browserstack.com/accounts/automate)
+
+`export BROWSERSTACK_USERNAME=<browserstack-username>`
+
+`export BROWSERSTACK_KEY=<browserstack-access-key>`
+
+### Run the tests
+
+ - To start a single test run: `composer test` or `composer test_single`
+ - To start parallel tests run: `composer test_parallel`
+ - To start local tests run: `composer test_local`
+
+-----
+
+#### Further Reading
 
-###Further Reading
 - [PHPUnit](https://phpunit.de/)
 - [BrowserStack documentation for Automate](https://www.browserstack.com/automate/php)
 
+#### How to specify the capabilities
+
+The [Code Generator](https://www.browserstack.com/automate/node#setting-os-and-browser) can come in very handy when specifying the capabilities especially for mobile devices.
+
 Happy Testing!

composer.json

@@ -0,0 +1,14 @@
+{
+  "require": {
+    "brianium/paratest": "dev-master",
+    "browserstack/local": "dev-master",
+    "phpunit/phpunit-selenium": "dev-master",
+    "facebook/webdriver": "dev-master"
+  },
+  "scripts": {
+    "test": "vendor/bin/phpunit tests/SampleSeleniumTest.php",
+    "test_local": "vendor/bin/phpunit tests/LocalSeleniumTest.php",
+    "test_single": "vendor/bin/phpunit tests/SampleSeleniumTest.php",
+    "test_parallel": "vendor/bin/paratest -p 3 -f --phpunit=vendor/bin/phpunit tests/ParallelSeleniumTest.php"
+  }
+}