Skip to content
This repository was archived by the owner on Jun 21, 2019. It is now read-only.

Commit 46a5140

Browse files
author
Arne Augenstein
committed
Merge branch 'master' into codeFormatting
2 parents 6f953f1 + 3d11421 commit 46a5140

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

README.md

+41-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,51 @@
11
# Matrix Client SDK for Java
22
[![Build Status](https://travis-ci.org/kamax-io/matrix-java-sdk.svg?branch=master)](https://travis-ci.org/kamax-io/matrix-java-sdk)
33

4+
## Purpose
45
Matrix SDK in Java 1.8 for:
56
- Client -> Identity Server
67
- Application Server -> Homeserver
78

9+
## Use
10+
### Gradle
11+
```
12+
repositories {
13+
maven {
14+
url 'https://kamax.io/maven/releases/'
15+
}
16+
}
17+
18+
dependencies {
19+
compile 'io.kamax:matrix-java-sdk:USE_LATEST_TAG'
20+
}
21+
```
22+
23+
### Maven
24+
```
25+
<repositories>
26+
<repository>
27+
<name>kamax-io</name>
28+
<url>https://kamax.io/maven/releases/</url>
29+
</repository>
30+
</repositories>
31+
<dependencies>
32+
<dependency>
33+
<groupId>io.kamax</groupId>
34+
<artifactId>matrix-java-sdk</artifactId>
35+
<version>USE_LATEST_TAG</version>
36+
</dependency>
37+
</dependencies>
38+
```
839
**WARNING:** This SDK was originally created to support [Kamax.io projects](https://github.com/kamax-io) and is therefore not necessarly complete. It will be built as the various projects evolve and grow. The SDK is therefore still in Alpha.
940

10-
Contributions and PRs are welcome to turn this into a fully fledged Matrix Java SDK.
41+
## Contribute
42+
Contributions and PRs are welcome to turn this into a fully fledged Matrix Java SDK.
43+
Your code will be licensed under AGPLv3
44+
45+
## Contact
46+
Matrix:
47+
- Join [#matrix-java-sdk:kamax.io](https://matrix.to/#/#matrix-java-sdk:kamax.io)
48+
- Read-only [view](https://view.matrix.org/room/!fQxAyfvcUDMivbUqFX:kamax.io/)
1149

12-
## Get in touch
13-
On Matrix at [#matrix-java-sdk:kamax.io](https://matrix.to/#/#matrix-java-sdk:kamax.io) - [Peek view](https://view.matrix.org/room/!fQxAyfvcUDMivbUqFX:kamax.io/)
50+
Email:
51+
- On our website [Kamax.io](https://www.kamax.io)

0 commit comments

Comments
 (0)