Skip to content

Commit 3124743

Browse files
committed
docs: add readme
License: MIT Signed-off-by: Henrique Dias <[email protected]>
1 parent ac95fb4 commit 3124743

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1-
# JS Testground SDK
1+
# JavaScript Testground SDK
22

3-
Under construction.
3+
> ⚠️ This SDK is a work in progress and can change at any time. Use it at your own risk.
4+
5+
![Testground logo](https://raw.githubusercontent.com/testground/pm/master/logo/TG_Banner_GitHub.jpg)
6+
7+
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
8+
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/testground/sdk-js/ci/master?style=flat-square)
9+
![Codecov](https://img.shields.io/codecov/c/github/testground/sdk-js?style=flat-square)
10+
11+
This repository contains the JavaScript SDK for developing [Testground](https://github.com/testground/testground) test plans.
12+
13+
## Install
14+
15+
```shell
16+
$ npm install @testground/sdk
17+
```
18+
19+
## Usage
20+
21+
See [testground.github.io/sdk-js](https://testground.github.io/sdk-js).
22+
23+
## Issues
24+
25+
Please report issues in the [`testground/testground` repo](https://github.com/testground/testground/issues).
26+
27+
## License
28+
29+
Dual-licensed: [MIT](./LICENSE-MIT), [Apache Software License v2](./LICENSE-APACHE), by way of the
30+
[Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).

0 commit comments

Comments
 (0)