Skip to content

Commit 4de070a

Browse files
improve README
1 parent c1ad1fe commit 4de070a

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ npm install testingbot-tunnel-launcher
1717
### Simple Usage
1818

1919
```javascript
20-
var testingbotTunnel = require('testingbot-tunnel-launcher');
20+
const testingbotTunnel = require('testingbot-tunnel-launcher');
2121

2222
testingbotTunnel({
2323
apiKey: 'key',
@@ -40,39 +40,38 @@ testingbotTunnel({
4040

4141
```javascript
4242

43-
var testingbotTunnel = require('testingbot-tunnel-launcher'),
44-
options = {
45-
46-
// The TestingBot API key which you can get for free, listed in our member area
47-
apiKey: 'key',
43+
const testingbotTunnel = require('testingbot-tunnel-launcher')
44+
const options = {
45+
// The TestingBot API key which you can get for free, listed in the TestingBot member area
46+
apiKey: 'key',
4847

49-
// The TestingBot API secret which you can get for free, listed in our member area
50-
apiSecret: 'secret',
48+
// The TestingBot API secret which you can get for free, listed in the TestingBot member area
49+
apiSecret: 'secret',
5150

52-
// More verbose output from the tunnel
53-
verbose: true,
51+
// More verbose output from the tunnel
52+
verbose: true,
5453

55-
// Port on which the tunnel Selenium relay will listen for
56-
// requests. Default 4445. (optional)
57-
se-port: null,
54+
// Port on which the tunnel Selenium relay will listen for
55+
// requests. Default 4445. (optional)
56+
se-port: null,
5857

59-
// Proxy host and port the tunnel can use to connect to an upstream proxy
60-
// e.g. "localhost:1234" (optional)
61-
proxy: null,
58+
// Proxy host and port the tunnel can use to connect to an upstream proxy
59+
// e.g. "localhost:1234" (optional)
60+
proxy: null,
6261

63-
// a comma-separated list of domains that
64-
// will not go through the tunnel. (optional)
65-
fast-fail-regexps: null,
62+
// a comma-separated list of domains that
63+
// will not go through the tunnel. (optional)
64+
fast-fail-regexps: null,
6665

67-
// Write logging output to this logfile (optional)
68-
logfile: null,
66+
// Write logging output to this logfile (optional)
67+
logfile: null,
6968

70-
// Change the tunnel version - see versions on https://testingbot.com/support/other/tunnel/changelog.html
71-
tunnelVersion: "4.0",
69+
// Change the tunnel version - see versions on https://testingbot.com/support/other/tunnel/changelog.html
70+
tunnelVersion: "4.0",
7271

73-
// Gives this tunnel a unique identifier
74-
tunnelIdentifier: "myIdentifier"
75-
};
72+
// Gives this tunnel a unique identifier
73+
tunnelIdentifier: "myIdentifier"
74+
};
7675

7776
testingbotTunnel(options, function(err, tunnel) {
7877
console.log("Started Tunnel");
@@ -85,9 +84,9 @@ testingbotTunnel(options, function(err, tunnel) {
8584

8685
### Credentials
8786

88-
You can pass the TestingBot credentials as `apiKey` and `apiSecret` in the options.
87+
You can pass the [TestingBot credentials](https://testingbot.com/members) as `apiKey` and `apiSecret` in the options.
8988

90-
You can also create a `~/.testingbot` file with `apiKey:apiSecret` as content
89+
You can also create a `.testingbot` file in your `$HOME` directory, with `apiKey:apiSecret` as contents.
9190

9291

9392
## Testing
@@ -139,7 +138,6 @@ npm test
139138
- First release of testingbot-tunnel-launcher
140139

141140

142-
143141
## MIT license
144142

145143
Copyright (c) TestingBot <[email protected]>

0 commit comments

Comments
 (0)