Skip to content

Commit ba5bf58

Browse files
Update README.md
1 parent 37711b9 commit ba5bf58

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# Loki
2-
This library uses reflection to automatically generate a GUI to change values of give fields.
2+
3+
Loki is a powerful, simple to use library that uses annotations to help you edit them in a GUI.
4+
5+
The intention of this Library is to remove a lot of work that it usually takes to create a GUI Element, in which you can edit values of an object.
6+
7+
## Table of content
8+
9+
- [Releases](#Releases)
10+
- [Current Goals](#Current Goals)
11+
- [HowTo](#HowTo)
12+
13+
14+
15+
## Releases
16+
17+
You can find all releases over [here](https://github.com/HephaistosCorp/Loki/releases)
18+
All releases are at the same time released as maven objects, that can be found over at [jitpack.io](https://jitpack.io)
19+
20+
Work is usually on hold for this library, unless there are breaking bugs or lack of an obvious feature.
21+
22+
Team Pandora takes care of development of this repository.
23+
24+
## Current Goals
25+
26+
Current released version is stable and there are no features in the pipelines.
27+
If you have any suggestions/bugs, feel free to share them over [here](https://github.com/HephaistosCorp/Loki/issues/new)!
28+
29+
30+
31+
## HowTo
32+
33+
There is a folder containing an example project where all possible features are implemented. You can check it out over [here](https://github.com/HephaistosCorp/Loki/tree/master/test/Example). You will find every use case for every feature inside of those classes.
34+
35+
For more information as well as the documentation, follow [this](https://hephaistoscorp.github.io/Loki/javaDoc/index.html) link.

0 commit comments

Comments
 (0)