Skip to content

Commit ab41f3f

Browse files
Added information to READ.me
1 parent 354fe22 commit ab41f3f

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,38 @@
1-
# testrail-api-kotlin-client
2-
TestRail API Client written in Kotlin
1+
# TestRail API Kotlin Client
2+
3+
## Setup
4+
5+
Set the following system properties with valid values:
6+
7+
* **testrailEndpoint**
8+
- Example:
9+
10+
`-DtestrailEndpoint="https://<some_endpoint>.testrail.io/"`
11+
* **testrailUsername**
12+
- Example:
13+
14+
`-DtestrailUsername="some_user@gmail.com"`
15+
* **testrailPassword**
16+
- Example:
17+
18+
`-DtestrailPassword="some_password!!!789"`
19+
20+
## Example Usage
21+
22+
###For in depth documentation refer to the [Wiki](https://github.com/chapeco/testrail-api-kotlin-client/wiki)
23+
24+
### Creating a new case in TestRail:
25+
26+
```
27+
val caseFoo = Case( sectionId = 1, title = "My Expected Case" ).addCase()
28+
```
29+
30+
31+
### Adding a result to an existing case in TestRail:
32+
33+
```
34+
val someRunId = 1
35+
val resultFoo = Result(caseId = 1, statusId = 1).addResultForCase(someRunId)
36+
```
37+
338

4-
CURRENTLY UNDER CONSTRUCTION - 1.0 Release coming soon!

0 commit comments

Comments
 (0)