Skip to content

Commit 07d1438

Browse files
committed
Corrected READMEs
1 parent 5c9ae93 commit 07d1438

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
![Maven Central](https://img.shields.io/maven-central/v/com.linked-planet.client/kotlin-jira-client-api)
33
[![kotlin-atlassian-client - default](https://github.com/linked-planet/kotlin-atlassian-client/actions/workflows/default.yml/badge.svg)](https://github.com/linked-planet/kotlin-atlassian-client/actions/workflows/default.yml)
44
![Jira 9.4.2](https://img.shields.io/badge/Jira-9.4.2-blue)
5-
![Confluence 7.19.5](https://img.shields.io/badge/Confluence-7.19.5-blue)
5+
![Confluence 7.19.5](https://img.shields.io/badge/Confluence-7.19.5-lightblue)
66
> *kotlin-atlassian-client* merges the libraries of the repositories *kotlin-http-client*, *kotlin-jira-client* and *kotlin-insight-client* originally implemented by @betacore.
77
88
## Docs

kotlin-jira-client/README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# kotlin-jira-client
2+
![Maven Central](https://img.shields.io/maven-central/v/com.linked-planet.client/kotlin-jira-client-api)
3+
![Jira 9.4.2](https://img.shields.io/badge/Jira-9.4.2-blue)
24

35
Provides a Kotlin client for interaction with Atlassian Jira. It provides management functionality for
46

@@ -22,25 +24,38 @@ The plugin is available on Maven Central.
2224
First you need to define a dependency to the desired variant and initialize your client as described in the sections
2325
below.
2426
Then you can simply use the client as it's shown
25-
in [AbstractMainTest](kotlin-jira-client/kotlin-jira-client-test-base/src/main/kotlin/com/linkedplanet/kotlinjiraclient/AbstractMainTest.kt).
27+
in [JiraClientTest](kotlin-jira-client-test-base/src/main/kotlin/com/linkedplanet/kotlinjiraclient/JiraClientTest.kt).
2628

2729
### SDK
2830

31+
| | **SDK** |
32+
|--------------------------|---------------------------------------|
33+
| Scope of application | Jira-Plugin |
34+
| Implementation | Atlassian Jira SDK libraries |
35+
| Advantages/Disadvantages | + Fast <br> - Limited to Jira-Plugins |
36+
2937
Add the following dependency to your `pom.xml`:
3038

3139
```xml
3240

3341
<dependency>
34-
<groupId>com.linked-planet</groupId>
42+
<groupId>com.linked-planet.client</groupId>
3543
<artifactId>kotlin-jira-client-sdk</artifactId>
3644
<version>${jira.client.version}</version>
3745
</dependency>
3846
```
3947

40-
For client initialization take a look at the [SDKClientTest](kotlin-jira-client/kotlin-jira-client-test-sdk/src/test/kotlin/it/SdkClientTest.kt).
48+
For client initialization take a look at the [JiraSdkClientTest](kotlin-jira-client-test-sdk/src/test/kotlin/it/JiraSdkClientTest.kt).
4149

4250
### HTTP
4351

52+
| Variant | **HTTP** |
53+
|--------------------------|-----------------------------------------------|
54+
| Scope of application | Any |
55+
| Implementation | Ktor or Atlassian Applink |
56+
| Advantages/Disadvantages | + Usable everywhere <br> - Comparatively slow |
57+
58+
4459
The HTTP variant requires an implementation of the `kotlin-http-client`.
4560

4661
#### HTTP via Atlassian Applinks
@@ -53,18 +68,18 @@ Specify the following dependency for usage:
5368
```xml
5469

5570
<dependency>
56-
<groupId>com.linked-planet</groupId>
71+
<groupId>com.linked-planet.client</groupId>
5772
<artifactId>kotlin-jira-client-http</artifactId>
5873
<version>${jira.client.version}</version>
5974
</dependency>
6075
<dependency>
61-
<groupId>com.linked-planet</groupId>
76+
<groupId>com.linked-planet.client</groupId>
6277
<artifactId>kotlin-http-client-atlas</artifactId>
6378
<version>${http.client.version}</version>
6479
</dependency>
6580
```
6681

67-
For client initialization take a look at the [ApplinkClientTest](kotlin-jira-client/kotlin-jira-client-test-applink/src/test/kotlin/it/ApplinkClientTest.kt).
82+
For client initialization take a look at the [JiraApplinkClientTest](kotlin-jira-client-test-applink/src/test/kotlin/it/JiraApplinkClientTest.kt).
6883

6984
#### HTTP via Ktor
7085

@@ -75,18 +90,18 @@ Specify the following dependency for usage:
7590
```xml
7691

7792
<dependency>
78-
<groupId>com.linked-planet</groupId>
93+
<groupId>com.linked-planet.client</groupId>
7994
<artifactId>kotlin-jira-client-http</artifactId>
8095
<version>${jira.client.version}</version>
8196
</dependency>
8297
<dependency>
83-
<groupId>com.linked-planet</groupId>
98+
<groupId>com.linked-planet.client</groupId>
8499
<artifactId>kotlin-http-client-ktor</artifactId>
85100
<version>${http.client.version}</version>
86101
</dependency>
87102
```
88103

89-
For client initialization take a look at the [KtorClientTest](kotlin-jira-client/kotlin-jira-client-test-ktor/src/test/kotlin/KtorClientTest.kt).
104+
For client initialization take a look at the [JiraKtorClientTest](kotlin-jira-client-test-ktor/src/test/kotlin/JiraKtorClientTest.kt).
90105

91106
## Project structure
92107

0 commit comments

Comments
 (0)