Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit d03550e

Browse files
committed
Address comments, add more info to Readme
1 parent b4fcb9e commit d03550e

File tree

4 files changed

+34
-3
lines changed

4 files changed

+34
-3
lines changed

Gruntfile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module.exports = function(grunt) {
1111
options: {
1212
configFile: '.eslintrc'
1313
},
14-
target: ['src/**/*.js']
14+
target: ['src/**/*.js', 'main.js']
1515
},
1616
githooks: {
1717
all: {

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# WebRTC utilities #
22
Contains shared utilities, support tools and frameworks for the other WebRTC sub repositories.
33

4+
## Install using npm ##
5+
´´´
6+
npm install webrtc-utilities --save-dev
7+
´´´
8+
9+
## SeleniumLib ##
10+
src/selenium-lib.js contains all that is needed to build a selenium webdriver driver for Chrome and Firefox (whatever is set in the env $BROWSER variable).
11+
It is used using require() in node.
12+
13+
## run-tests ##
14+
A bash shell script that helps travis-multirunner to download and install Chrome and Firefox browser from stable, beta and unstable channels.
15+
416
## Development ##
5-
Detailed information on developing in the [webrtc](https://github.com/webrtc) github repo can be found in the [WebRTC GitHub repo developer's guide](https://docs.google.com/document/d/1tn1t6LW2ffzGuYTK3366w1fhTkkzsSvHsBnOHoDfRzY/edit?pli=1#heading=h.e3366rrgmkdk).
17+
Add new utilities under the src folder and add them to the main.js file in the project root with the appropriate module.export set.
18+
19+
Detailed information on developing in the [webrtc](https://github.com/webrtc) github repositories can be found in the [WebRTC GitHub repo developer's guide](https://docs.google.com/document/d/1tn1t6LW2ffzGuYTK3366w1fhTkkzsSvHsBnOHoDfRzY/edit?pli=1#heading=h.e3366rrgmkdk).

main.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/*
2+
* Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
3+
*
4+
* Use of this source code is governed by a BSD-style license
5+
* that can be found in the LICENSE file in the root of the source
6+
* tree.
7+
*/
8+
/* eslint-env node */
9+
10+
'use strict';
11+
12+
// Add all modules to be exported here.
13+
var seleniumLib = require('./src/selenium/selenium-lib.js')
14+
15+
module.export = {
16+
seleniumLib: seleniumLib;
17+
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"author": "The WebRTC project authors (https://www.webrtc.org/)",
55
"description": "WebRTC test framework utilities.",
66
"license": "BSD-3-Clause",
7-
"main": "src/selenium/selenium-lib.js",
7+
"main": "main.js",
88
"repository": {
99
"type": "git",
1010
"url": "https://github.com/webrtc/utilities.git"

0 commit comments

Comments
 (0)