Skip to content

Commit d402e80

Browse files
committed
Update documentation
1 parent eab312a commit d402e80

File tree

1 file changed

+38
-10
lines changed

1 file changed

+38
-10
lines changed

docs/README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and an example function that shows how to extend Jactl with your own application
99
## Requirements
1010

1111
* Java 11+
12-
* Jactl 1.0
12+
* Jactl 1.0.0
1313
* Gradle 8.0.2
1414
* Vert.x 4.4.0
1515
* jackson-databind 2.0.1
@@ -22,7 +22,7 @@ cd jactl-vertx
2222
./gradlew build testJar
2323
```
2424

25-
That will build `jactl-vertx-1.0.jar` and `jactl-vertx-1.0-SNAPSHOT-tests.jar` under the `build/libs` directory.
25+
That will build `jactl-vertx-1.0.0.jar` and `jactl-vertx-1.0.0-SNAPSHOT-tests.jar` under the `build/libs` directory.
2626

2727
To push to your Maven repository you can use `publishToMaven`:
2828
```shell
@@ -31,16 +31,44 @@ To push to your Maven repository you can use `publishToMaven`:
3131

3232
## Integration
3333

34-
To include the library in your application add the following gradle dependency:
34+
### Dependency
35+
36+
To use Jactl you will need to add a dependency on the Jactl library.
37+
38+
#### Gradle
39+
40+
In the `dependencies` section of your `build.gradle` file:
3541
```groovy
36-
implementation group:'io.jactl', name:'jactl-vertx', version:'1.0'
42+
implementation group: 'io.jactl', name: 'jactl-vertx', version: '1.0.0'
3743
```
3844

3945
If you want to use the example `sendReceiveJson()` function then also include a dependency on the `tests` jar:
4046
```groovy
41-
implementation group:'io.jactl', name:'jactl-vertx', version:'1.0', classifier:'tests'
47+
implementation group:'io.jactl', name:'jactl-vertx', version:'1.0.0', classifier:'tests'
4248
```
4349

50+
### Maven
51+
52+
In the `dependencies` section of your `pom.xml`:
53+
```xml
54+
<dependency>
55+
<groupId>io.jactl</groupId>
56+
<artifactId>jactl-vertx</artifactId>
57+
<version>1.0.0</version>
58+
</dependency>
59+
```
60+
61+
To also include the `tests` jar:
62+
```xml
63+
<dependency>
64+
<groupId>io.jactl</groupId>
65+
<artifactId>jactl-vertx</artifactId>
66+
<version>1.0.0</version>
67+
<classifier>tests</classifier>
68+
</dependency>
69+
```
70+
71+
4472
### Jactl Environment Class
4573

4674
The `io.jactl.vertx.JactlVertxEnv` class provides a bridge between the Jactl runtime and the Vert.x runtime
@@ -88,7 +116,7 @@ To include these methods/functions in your Jactl REPL or Jactl commandline scrip
88116
configuration file to include something like the following:
89117

90118
```groovy
91-
def VERS = '1.0' // The jactl-vertx version to use
119+
def VERS = '1.0.0' // The jactl-vertx version to use
92120
def LIBS = "~/.m2/repository/io/jactl/jactl-vertx/${VERS}" // Location of the jars
93121
94122
// Specify the Vertx based environment class to use
@@ -203,19 +231,19 @@ going to run from and then add the `jactl-vertx` jar and `jactl-vertx` `tests` j
203231
and invoke `io.jactl.vertx.example.ExampleWebServer`.
204232
By default, it will listen on a random port:
205233
```shell
206-
$ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer
234+
$ java -cp jactl-vertx-1.0.0-tests.jar:jactl-vertx-1.0.0.jar io.jactl.vertx.example.ExampleWebServer
207235
Listening on localhost:52178
208236
```
209237

210238
If you pass in a port number on the command line it will use that instead:
211239
```shell
212-
$ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
240+
$ java -cp jactl-vertx-1.0.0-tests.jar:jactl-vertx-1.0.0.jar io.jactl.vertx.example.ExampleWebServer 8080
213241
Listening on localhost:8080
214242
```
215243

216244
You can specify the host address to listen on by using `hostname:port`:
217245
```shell
218-
$ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
246+
$ java -cp jactl-vertx-1.0.0-tests.jar:jactl-vertx-1.0.0.jar io.jactl.vertx.example.ExampleWebServer 8080
219247
Listening on localhost:8080
220248
```
221249

@@ -227,7 +255,7 @@ port.
227255

228256
Assume we run it on port 8080:
229257
```shell
230-
$ java -cp jactl-vertx-1.0-tests.jar:jactl-vertx-1.0.jar io.jactl.vertx.example.ExampleWebServer 8080
258+
$ java -cp jactl-vertx-1.0.0-tests.jar:jactl-vertx-1.0.0.jar io.jactl.vertx.example.ExampleWebServer 8080
231259
Listening on localhost:8080
232260
```
233261

0 commit comments

Comments
 (0)