Skip to content

Commit da8dbc1

Browse files
committed
Add README.md
1 parent 4147395 commit da8dbc1

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Axon Framework - Kotlin Extension
2+
3+
_Note:_ This extension is still in an experimental stage.
4+
5+
Axon Framework is a framework for building evolutionary, event-driven microservice systems,
6+
based on the principles of Domain Driven Design, Command-Query Responsibility Segregation (CQRS) and Event Sourcing.
7+
8+
As such it provides you the necessary building blocks to follow these principles.
9+
Building blocks like Aggregate factories and Repositories, Command, Event and Query Buses and an Event Store.
10+
The framework provides sensible defaults for all of these components out of the box.
11+
12+
This set up helps you create a well structured application without having to bother with the infrastructure.
13+
The main focus can thus become your business functionality.
14+
15+
This repository provides an extension to the Axon Framework: Kotlin. It provides functionality to leverage Kotlin features to be used with Axon Framework.
16+
17+
For more information on anything Axon, please visit our website, [http://axoniq.io](http://axoniq.io).
18+
19+
## Getting started
20+
21+
## Receiving help
22+
23+
Are you having trouble using the extension?
24+
We'd like to help you out the best we can!
25+
There are a couple of things to consider when you're traversing anything Axon:
26+
27+
* Checking the [reference guide](https://docs.axoniq.io/reference-guide/extensions/) should be your first stop,
28+
as the majority of possible scenarios you might encounter when using Axon should be covered there.
29+
* If the Reference Guide does not cover a specific topic you would've expected,
30+
we'd appreciate if you could file an [issue](https://github.com/AxonIQ/reference-guide/issues) about it for us.
31+
* There is a a [public mailing list](https://groups.google.com/forum/#!forum/axonframework) to support you in the case
32+
the reference guide did not sufficiently answer your question.
33+
* Next to the mailing list we also monitor Stack Overflow for any questions which are tagged with `axon`.
34+
35+
## Feature requests and issue reporting
36+
37+
We use GitHub's [issue tracking system](https://github.com/AxonFramework/extension-kotlin/issues) for new feature
38+
request, extension enhancements and bugs.
39+
Prior to filing an issue, please verify that it's not already reported by someone else.
40+
41+
When filing bugs:
42+
* A description of your setup and what's happening helps us figuring out what the issue might be
43+
* Do not forget to provide version you're using
44+
* If possible, share a stack trace, using the Markdown semantic ```
45+
46+
When filing features:
47+
* A description of the envisioned addition or enhancement should be provided
48+
* (Pseudo-)Code snippets showing what it might look like help us understand your suggestion better
49+
* If you have any thoughts on where to plug this into the framework, that would be very helpful too
50+
* Lastly, we value contributions to the framework highly. So please provide a Pull Request as well!
51+
52+
## Credits
53+
54+
---

0 commit comments

Comments
 (0)