Skip to content

Commit ea761f9

Browse files
authored
Update README.md
1 parent 8810aa5 commit ea761f9

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1-
# prerequisites-tester
2-
A tester application used to verify that a customer environment's prerequisites for using Lightrun are met
1+
# Lightest
2+
Lightest is a tester application used to verify that a customer environment's prerequisites for using Lightrun are met.
3+
4+
Currently, the test application supports the following tests:
5+
- **Long polling test** - which tests that the test application can register as a Lightrun agent and perform `getBreakpoints` long polling requests for a period of time.
6+
- **Websocket connectivity test** - which tests that the test application can authenticate as a Lightrun client, establish a websocket connection and maintain its connectivity for a period of time.
7+
8+
## Usage
9+
10+
Since Go supports cross-compiling and comes with a built-in compiler support for multiple OSs and architectures, building a OS and architecture specific executables is simple.
11+
The Github release page should include the latest distributions for a combination of OSs and architectures we would like to support.
12+
Running the tester simply requires running the relevant distributed executable.
13+
14+
### Configuration
15+
16+
Before running the executable, the accompanied `config.json` file should be configured according to your needs.
17+
Configuring it is straightforward, as the necessary configuration file parameters written in the config should be relatively self-explanatory.
18+
19+
20+

0 commit comments

Comments
 (0)