README.md 3.1 KB
Newer Older
AtjonTV's avatar
AtjonTV committed
1 2
# kLib

AtjonTV's avatar
AtjonTV committed
3 4
| Branch | Status |
|--------|--------|
AtjonTV's avatar
AtjonTV committed
5
| master | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/master/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/master) |
AtjonTV's avatar
AtjonTV committed
6 7
| release/3.2.x | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/release/3.2.x/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/release/3.2.x) |
| release/4.0.x | [![pipeline status](https://gitlab.atvg-studios.com/atvg-studios/kLib/badges/release/4.0.x/pipeline.svg)](https://gitlab.atvg-studios.at/atvg-studios/kLib/commits/release/4.0.x) |
AtjonTV's avatar
AtjonTV committed
8

AtjonTV's avatar
AtjonTV committed
9
kLib is a in Kotlin written Library by ATVG-Studios containing a set of useful Functions,
AtjonTV's avatar
AtjonTV committed
10 11 12 13
Extensions and Types.

kLib works as a Standard Library at ATVG-Studios containing code that can be used across many applications in a generic way.

AtjonTV's avatar
AtjonTV committed
14 15
Checkout the Homepage over [here](https://klib.atvg-studios.com).

AtjonTV's avatar
AtjonTV committed
16
kLib is now available via a custom Maven repository.  
AtjonTV's avatar
AtjonTV committed
17 18
You can find the Git repository that hosts the Maven data [here](https://gitlab.atvg-studios.com/atvg-studios/maven-repository).  
The Maven Repository itself is available here: https://mvn.atvg-studios.com
AtjonTV's avatar
AtjonTV committed
19

AtjonTV's avatar
AtjonTV committed
20
Adding the latest version of kLib using Gradle:
AtjonTV's avatar
AtjonTV committed
21 22 23

```
repositories {
AtjonTV's avatar
AtjonTV committed
24
    maven { url 'https://mvn.atvg-studios.com' }
AtjonTV's avatar
AtjonTV committed
25 26 27
}

dependencies {
AtjonTV's avatar
AtjonTV committed
28
    implementation "com.atvgstudios:klib:+"
AtjonTV's avatar
AtjonTV committed
29 30 31
}
```

AtjonTV's avatar
AtjonTV committed
32
Adding the latest version of kLib using Maven:
AtjonTV's avatar
AtjonTV committed
33 34 35 36 37 38

```
<repositories>
  <repository>
    <id>atvg-studios</id>
    <name>ATVG-Studios Maven</name>
AtjonTV's avatar
AtjonTV committed
39
    <url>https://mvn.atvg-studios.com</url>
AtjonTV's avatar
AtjonTV committed
40 41 42 43 44 45
  </repository>
</repositories>
<dependencies>
  <dependency>
    <groupId>com.atvgstudios</groupId>
    <artifactId>klib</artifactId>
AtjonTV's avatar
AtjonTV committed
46
    <version>[0.1.0,)</version>
AtjonTV's avatar
AtjonTV committed
47 48 49 50
  </dependency>
</dependencies>
```

AtjonTV's avatar
AtjonTV committed
51 52 53 54 55 56 57 58 59 60 61 62 63
# Contributing

If you want to contribute, please add your name, email, company (if any) and homepage (if any) to the Authors Array in the kLibInfo.

Please read the [CONTRIBUTION GUIDE](CONTRIBUTING.md) before doing any dedicated development.

# Third-Party Code

kLib may contain code that was written by ATVG-Studios based on code by others.

Copying code is strictly **NOT** allowed. Rewriting code in our in-house coding style however, may be allow as long as the
original code is **NOT** protected by a License, Patent or Agreement.

AtjonTV's avatar
AtjonTV committed
64 65 66 67 68 69
# Version Compatibility

Checkout our doc about [Compatibility](Compatibility.md).  
It contains information about which versions are compatible without issues.  
Also what breaking changes where made when and which will come up in near future!

AtjonTV's avatar
AtjonTV committed
70 71
## Outdated Versions

AtjonTV's avatar
AtjonTV committed
72 73 74 75 76 77 78 79
All listed versions are considered Legacy and are no longer developed or supported.

| Version Tree | Last Version |
|--------------|--------------|
|    0.1.x     |    0.1.6     |
|    0.2.x     |    0.2.2     |
|    1.x.x     |    1.4.0     |
|    2.x.x     |    2.1.1     |
AtjonTV's avatar
AtjonTV committed
80 81
|    3.0.x     |    3.0.0     |
|    3.1.x     |    3.1.0     |
AtjonTV's avatar
AtjonTV committed
82

AtjonTV's avatar
AtjonTV committed
83 84
# License

AtjonTV's avatar
AtjonTV committed
85
kLib is distributed under the [OSPL 20](LICENSE) License (a MPL 2.0 Fork).
AtjonTV's avatar
AtjonTV committed
86

AtjonTV's avatar
AtjonTV committed
87
The usage of kLib may be written in a "Open-Source Licenses" section of a Legal Notice or a End User License Agreement (EULA). (This is **NOT** a strict requirement.)