Merge pull request #2 from browserstack/module

Create Module Structure

Author: shirish87

README.md

@@ -4,25 +4,39 @@
 Sample for using karma-browserstack-launcher to run Karma tests (QUnit framework) on BrowserStack infrastructure.
 One test is failing on purpose as a demo of BrowserStack catching bugs in different browsers.
 
-###Clone this repository
-- `git clone https://github.com/browserstack/karma-browserstack-example.git`
+### Prerequisites
+Node and npm
 
-###Install karma-browserstack-launcher
-- `npm -g install karma-browserstack-launcher`
+### Clone this repository
+`git clone https://github.com/browserstack/karma-browserstack-example.git`
 
-###Configuring the json
- - Open `karma.conf.js`
- - Replace `username` and `key` with your BrowserStack credentials. Don't have one? Get one on BrowserStack [dashboard]
- - You can further customize configuration in karma.conf.js. For detailed reference, visit karma-browserstack-launcher github repository [here].
+### Install dependencies
 
-###Sample test
- - To run: `karma start`
+Navigate to appropriate directory for testing and then install the dependencies by running
+
+`npm install`
+
+### BrowserStack Configuration
+
+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>`
+
+You can further customize configuration in karma.conf.js. For detailed reference, visit karma-browserstack-launcher github repository [here](https://github.com/browserstack/karma-browserstack-launcher).
+
+#### Run the tests
+
+Execute the following command to run the karma tests:
+
+`npm test`
 
 ###Note
- - IE 6 and 7 Tests on Karma version 0.13 may fail(output - browser not captured).
- - Use Karmav0.12 or below and add `transports: ['websocket','jsonp-polling']` to the karma.conf.js file
- - Checkout [karma issue] for more details.
+- IE 6 and 7 Tests on Karma version 0.13 may fail(output - browser not captured).
+- Use Karmav0.12 or below and add `transports: ['websocket','jsonp-polling']` to the karma.conf.js file
+- Checkout [karma issue] for more details.
 
-[here]:https://github.com/browserstack/karma-browserstack-launcher
 [dashboard]:https://www.browserstack.com/automate
 [karma issue]:https://github.com/karma-runner/karma/issues/983

karma.conf.js

@@ -54,8 +54,8 @@ module.exports = function(config) {
     autoWatch: false,
 
     browserStack: {
-      username: 'jamesbond',
-      accessKey: '007'
+      username: process.env.BROWSERSTACK_USERNAME,
+      accessKey: process.env.BROWSERSTACK_KEY
     },
 
     // define browsers

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "karma-browserstack-example",
+  "version": "1.0.0",
+  "description": "Sample To test Karma with BrowserStack",
+  "main": "karma.conf.js",
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "test": "karma start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/browserstack/karma-browserstack-example.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/browserstack/karma-browserstack-example/issues"
+  },
+  "homepage": "https://github.com/browserstack/karma-browserstack-example#readme",
+  "dependencies": {
+    "karma": "^0.13.11",
+    "karma-browserstack-launcher": "^0.1.5",
+    "karma-qunit": "^0.1.5",
+    "qunitjs": "^1.19.0"
+  }
+}