Skip to content

Commit f3a5dbf

Browse files
Merge pull request #78 from testomatio/readme-update
updated readme due to the latest fixes
2 parents 5ec588d + f0acdf6 commit f3a5dbf

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,8 @@ and team collaboration features.
6060
<version>0.x.x</version>
6161
</dependency>
6262
```
63-
2. create the `testomatio.properties` file in your `resources` folder and add into it:
64-
```properties
65-
testomatio.listening=true
66-
```
67-
3. **Get your API key** from [Testomat.io](https://app.testomat.io/) (starts with `tstmt_`)
68-
4. **Set your API key** as environment variable:
63+
2. **Get your API key** from [Testomat.io](https://app.testomat.io/) (starts with `tstmt_`)
64+
3. **Set your API key** as environment variable:
6965
```bash
7066
export testomatio=tstmt_your_key_here
7167
```
@@ -74,8 +70,8 @@ and team collaboration features.
7470
testomatio=tstmt_your_key_here
7571
```
7672

77-
5. Also provide run title in the `testomatio.run.title` property otherwise runs will have name "Default Test Run".
78-
73+
4. Also provide run title in the `testomatio.run.title` property otherwise runs will have name "Default Test Run".
74+
5. IMPORTANT: The reporter will run automatically if the API_KEY is provided in any way!
7975
---
8076

8177
## Framework specific setup
@@ -170,30 +166,30 @@ This lets you customize how the reporter works by overriding core classes:
170166
```properties
171167
# Your Testomat.io project API key (find it in your project settings)
172168
testomatio=tstmt_your_key_here
173-
testomatio.listening=ture
174169
```
175-
170+
Or provide it as JVM property or ENV variable.
171+
IMPORTANT: The reporter will run automatically if the API_KEY is provided in any way!
176172
### 🎨 Customization Options
177173

178174
Make your test runs exactly how you want them:
179175

180-
| Setting | What it does | Default | Example |
181-
|----------------------------|---------------------------------------|---------------------|------------------------------|
182-
| **`testomatio.run.title`** | Custom name for your test run | `default_run_title` | `"Nightly Regression Tests"` |
183-
| **`testomatio.env`** | Environment name (dev, staging, prod) | _(none)_ | `"staging"` |
184-
| **`testomatio.run.group`** | Group related runs together | _(none)_ | `"sprint-23"` |
185-
| **`testomatio.publish`** | Make results publicly shareable | _(private)_ | `1` |
176+
| Setting | What it does | Default | Example |
177+
|----------------------------|---------------------------------------|---------------------|-----------------------------------------------|
178+
| **`testomatio.run.title`** | Custom name for your test run | `default_run_title` | `"Nightly Regression Tests"` |
179+
| **`testomatio.env`** | Environment name (dev, staging, prod) | _(none)_ | `"staging"` |
180+
| **`testomatio.run.group`** | Group related runs together | _(none)_ | `"sprint-23"` |
181+
| **`testomatio.publish`** | Make results publicly shareable | _(private)_ | Any not null/empty/"0" string, "0" to disable |
186182

187183
### 🔗 Advanced Integration
188184

189-
| Setting | What it does | Example |
190-
|-------------------------------------|------------------------------------------|----------------------------|
191-
| **`testomatio.url`** | Custom Testomat.io URL (for enterprise) | `https://app.testomat.io/` |
192-
| **`testomatio.run.id`** | Add results to existing run | `"run_abc123"` |
193-
| **`testomatio.create`** | Auto-create missing tests in Testomat.io | `true` |
194-
| **`testomatio.shared.run`** | Shared run name for team collaboration | `"team-integration-tests"` |
195-
| **`testomatio.shared.run.timeout`** | How long to wait for shared run | `3600` |
196-
| **`testomatio.export.required`** | Exports your tests code to Testomat.io | `true` |
185+
| Setting | What it does | Example |
186+
|-------------------------------------|------------------------------------------|-----------------------------------------------|
187+
| **`testomatio.url`** | Custom Testomat.io URL (for enterprise) | `https://app.testomat.io/` |
188+
| **`testomatio.run.id`** | Add results to existing run | `"run_abc123"` |
189+
| **`testomatio.create`** | Auto-create missing tests in Testomat.io | `true` |
190+
| **`testomatio.shared.run`** | Shared run name for team collaboration | Any not null/empty/"0" string, "0" to disable |
191+
| **`testomatio.shared.run.timeout`** | How long to wait for shared run | `3600` |
192+
| **`testomatio.export.required`** | Exports your tests code to Testomat.io | `true` |
197193

198194
---
199195

0 commit comments

Comments
 (0)