Skip to content

Commit 917775d

Browse files
committed
Improved doc
1 parent 8727bb5 commit 917775d

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@
88

99
The Jenkins API Client For Java has now moved under the umbrella of the Jenkins GitHub Organization.
1010

11+
## What is the "Jenkins API Client for Java"
12+
13+
This library is a just a piece of java code which uses the REST API of jenkins.
14+
This means you can trigger builds, extract informations about jobs or builds
15+
etc. from jenkins. The information you can extract will be represented in java
16+
objects which you can reuse for other purposes or integrate this library into
17+
other parts for a higher level of integration.
18+
1119
## Getting Started
1220

13-
To get started add the following dependency to your project
21+
If you like to use this library you need to add the library as a dependency
22+
to your project. This can be done by using a Maven dependency like the following:
1423

1524
```xml
1625
<dependency>
@@ -20,6 +29,12 @@ To get started add the following dependency to your project
2029
</dependency>
2130
```
2231

32+
This can also being done by defining a Gradle dependency like this:
33+
34+
```
35+
compile 'com.offbytwo.jenkins:jenkins-client:0.3.7'
36+
``
37+
2338
Starting with a future release 0.4.0 the groupId/artifactId will change (NOT YET DONE!)
2439
2540
```xml
@@ -72,7 +87,7 @@ To run integration tests simply start
7287
mvn -Prun-its clean verify
7388
```
7489

75-
There is also a sub project which contains [integration tests][integration-tests]
90+
There is also a module which contains [integration tests][integration-tests]
7691
which are running with a special version of Jenkins
7792
within a Docker container to check several aspects of the API which can't be
7893
covered by the usual integration tests.
@@ -126,7 +141,7 @@ create/add/fix several issues in one, cause otherwise the history is hard to
126141
read and to understand and makes the maintenance of the issues and pull request
127142
hard or to be honest impossible.
128143

129-
Furthermore it is neccesary to create appropriate entries into the `ReleaseNotes.md`
144+
Furthermore it is necessary to create appropriate entries into the `ReleaseNotes.md`
130145
file as well.
131146

132147

0 commit comments

Comments
 (0)