Skip to content

Commit 0d4b049

Browse files
authored
Merge pull request #3 from rchougule/readme_additions
Readme additions
2 parents 7fc6d5b + ef7a901 commit 0d4b049

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

.github/workflows/setup-env.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'unit tests: setting test env for BrowserStack'
1+
name: 'setup-env'
22
on:
33
pull_request:
44
paths:

.github/workflows/setup-local.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'unit tests: setting local binary for BrowserStack'
1+
name: 'setup-local'
22
on:
33
pull_request:
44
paths:

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# BrowserStack GitHub Actions
22

3+
<p align="center">
4+
<a href="https://browserstack.com"><img alt="BrowserStack Logo" src="https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-invoice.svg"></a>
5+
</p>
6+
7+
<p align="center">
8+
<a href="https://github.com/browserstack/github-actions/actions?query=workflow%3Asetup-env"><img alt="setup-env build status" src="https://github.com/browserstack/github-actions/workflows/setup-env/badge.svg"></a>
9+
<a href="https://github.com/browserstack/github-actions/actions?query=workflow%3Asetup-local"><img alt="setup-local build status" src="https://github.com/browserstack/github-actions/workflows/setup-local/badge.svg"></a>
10+
</p>
11+
312
This respository contains a library of GitHub Actions to help you integrate your test suite with the [BrowserStack](https://browserstack.com) device cloud.
413

514
You need a BrowserStack username and access-key to run your tests on the BrowserStack device cloud. You can [sign-up for free trial](https://www.browserstack.com/users/sign_up) if you do not have an existing account.
@@ -11,7 +20,7 @@ If you want to test your open source project on BrowserStack, then [sign-up here
1120

1221
* [setup-local](./setup-local): This Action downloads and starts the appropriate BrowserStackLocal binary, thereby creating a secure tunnel connection from the GitHub Actions runner environment to the BrowserStack device cloud. This secure tunnel will be used by the remote browsers in BrowserStack to access your web application hosted in the GitHub Actions runner environment. **You do not need this Action if the application to be tested is accessible over the public internet.**
1322

14-
## Pre-requisites
23+
## Prerequisites
1524
* You should set your BrowserStack Username and Access Key as GitHub Secrets, i.e. `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` respectively.
1625

1726
## Usage

0 commit comments

Comments
 (0)