Skip to content

Commit 4df653f

Browse files
authored
Add basic README.md [skip ci] (#24)
1 parent 39acbab commit 4df653f

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+
# Helios
2+
3+
Helios is a core library that improves upon several shortcomings of the Java core libraries.
4+
5+
## Quick Links
6+
7+
- [📔 Javadocs](https://repo.sparky983.me/javadoc/snapshots/me/sparky983/helios/0.1.0-SNAPSHOT/me.sparky983.helios/module-summary.html)
8+
9+
## Warnings
10+
11+
- This library is still in development, and as such, is subject to change at any time.
12+
- The APIs are not designed with performance in mind, and as such, should not be used in
13+
performance-critical code.
14+
15+
## Installation
16+
17+
### pom.xml
18+
19+
```xml
20+
<repository>
21+
<id>sparky983-snapshots</id>
22+
<url>https://repo.sparky983.me/snapshots</url>
23+
</repository>
24+
25+
<dependency>
26+
<groupId>me.sparky983</groupId>
27+
<artifactId>helios</artifactId>
28+
<version>0.1.0-SNAPSHOT</version>
29+
</dependency>
30+
```
31+
32+
### build.gradle
33+
34+
```groovy
35+
repositories {
36+
maven { url 'https://repo.sparky983.me/snapshots' }
37+
}
38+
39+
dependencies {
40+
implementation 'me.sparky983:helios:0.1.0-SNAPSHOT'
41+
}
42+
```
43+
44+
### build.gradle.kts
45+
46+
```kts
47+
repositories {
48+
maven("https://repo.sparky983.me/snapshots")
49+
}
50+
51+
dependencies {
52+
implementation("me.sparky983:helios:0.1.0-SNAPSHOT")
53+
}
54+
```

0 commit comments

Comments
 (0)