Skip to content

Commit 9abca2f

Browse files
committed
better readme, updated version, fix #154
1 parent 32d1b8e commit 9abca2f

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ _Note:_ This extension is still in an experimental stage.
99
Axon Framework is a framework for building evolutionary, event-driven microservice systems,
1010
based on the principles of Domain Driven Design, Command-Query Responsibility Segregation (CQRS) and Event Sourcing.
1111

12-
As such it provides you the necessary building blocks to follow these principles.
12+
As such it provides you the necessary building blocks to follow these principles.
1313
Building blocks like Aggregate factories and Repositories, Command, Event and Query Buses and an Event Store.
1414
The framework provides sensible defaults for all of these components out of the box.
1515

@@ -24,43 +24,62 @@ For more information on anything Axon, please visit our website, [http://axoniq.
2424

2525
### Dependencies
2626

27+
For the Kotlin extension itself plese use the following coordinates:
28+
2729
**Maven**
2830

2931
```
3032
<dependency>
3133
<groupId>org.axonframework.extensions.kotlin</groupId>
3234
<artifactId>axon-kotlin</artifactId>
33-
<version>0.1.0</version>
35+
<version>0.2.0</version>
3436
</dependency>
3537
```
3638

3739
**Gradle**
3840

3941
```
40-
implementation("org.axonframework.extensions.kotlin:axon-kotlin:0.1.0")
42+
implementation("org.axonframework.extensions.kotlin:axon-kotlin:0.2.0")
43+
```
44+
45+
For the Kotlin testing extension itself plese use the following coordinates:
46+
47+
**Maven**
48+
49+
```
50+
<dependency>
51+
<groupId>org.axonframework.extensions.kotlin</groupId>
52+
<artifactId>axon-kotlin-test</artifactId>
53+
<version>0.2.0</version>
54+
</dependency>
4155
```
4256

57+
**Gradle**
58+
59+
```
60+
implementation("org.axonframework.extensions.kotlin:axon-kotlin-test:0.2.0")
61+
```
4362

4463

4564
## Receiving help
4665

47-
Are you having trouble using the extension?
66+
Are you having trouble using the extension?
4867
We'd like to help you out the best we can!
4968
There are a couple of things to consider when you're traversing anything Axon:
5069

5170
* Checking the [reference guide](https://docs.axoniq.io/reference-guide/extensions/kotlin) should be your first stop,
5271
as the majority of possible scenarios you might encounter when using Axon should be covered there.
5372
* If the Reference Guide does not cover a specific topic you would've expected,
54-
we'd appreciate if you could file an [issue](https://github.com/AxonIQ/reference-guide/issues) about it for us.
73+
we'd appreciate if you could file an [issue](https://github.com/AxonIQ/reference-guide/issues) about it for us.
5574
* There is a [forum](https://discuss.axoniq.io/) to support you in the case the reference guide did not sufficiently answer your question.
5675
Axon Framework and Server developers will help out on a best effort basis.
5776
Know that any support from contributors on posted question is very much appreciated on the forum.
5877
* Next to the forum we also monitor Stack Overflow for any questions which are tagged with `axon`.
5978

6079
## Feature requests and issue reporting
6180

62-
We use GitHub's [issue tracking system](https://github.com/AxonFramework/extension-kotlin/issues) for new feature
63-
request, extension enhancements and bugs.
81+
We use GitHub's [issue tracking system](https://github.com/AxonFramework/extension-kotlin/issues) for new feature
82+
request, extension enhancements and bugs.
6483
Prior to filing an issue, please verify that it's not already reported by someone else.
6584

6685
When filing bugs:
@@ -70,21 +89,21 @@ When filing bugs:
7089

7190
When filing features:
7291
* A description of the envisioned addition or enhancement should be provided
73-
* (Pseudo-)Code snippets showing what it might look like help us understand your suggestion better
92+
* (Pseudo-)Code snippets showing what it might look like help us understand your suggestion better
7493
* If you have any thoughts on where to plug this into the framework, that would be very helpful too
7594
* Lastly, we value contributions to the framework highly. So please provide a Pull Request as well!
76-
95+
7796
## Building the extension
7897

7998
If you want to build the extension locally, you need to check it out from GiHub and run the following command:
8099

81100
./mvnw clean install
82-
101+
83102
### Producing JavaDocs and Sources archive
84103

85104
Please execute the following command line if you are interested in producing KDoc and Source archives:
86105

87106
./mvnw clean install -Pjavadoc-and-sources
88-
89-
107+
108+
90109
---

0 commit comments

Comments
 (0)