update readme

This commit is contained in:
FalsePattern committed 2022-06-08 16:01:12 +02:00
1 parent 025b47669f
commit a506a88df0
1 file changed
+10 -10
+10 -10
View File
@@ -1,19 +1,19 @@
A library mod for 1.7.10 with lots of useful stuff. See the table below for more information.
| Package | Contents / Purpose |
|-----------------------------------------------------------------|-----------------------------------------------------------------|
| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2 |
| [config](src/main/java/com/falsepattern/lib/config) | 1.12.2-style annotation-based config library |
| [dependencies](src/main/java/com/falsepattern/lib/dependencies) | Runtime dependency loader which uses Maven |
| [mixin](src/main/java/com/falsepattern/lib/mixin) | Mixin loader plugin boilerplate code |
| [text](src/main/java/com/falsepattern/lib/text) | Better Chat and GUI text processing |
| Package | Contents / Purpose |
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2 |
| [config](src/main/java/com/falsepattern/lib/config) | 1.12.2-style annotation-based config library |
| [dependencies](src/main/java/com/falsepattern/lib/dependencies) | Runtime dependency loader which uses Maven |
| [mixin](src/main/java/com/falsepattern/lib/mixin) | Mixin loader plugin boilerplate code |
| [text](src/main/java/com/falsepattern/lib/text) | Better Chat and GUI text processing |
| [util](src/main/java/com/falsepattern/lib/util) | Additional utilities that do not fit the above categories, see below for more information |
The contents of the [util](src/main/java/com/falsepattern/lib/util) package so far:
| Class | Purpose |
|--------------|----------------------------------------------------------------------------------------------------------------|
| ResourceUtil | Provides methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
| Class | Purpose |
|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| [ResourceUtil](src/main/java/com/falsepattern/lib/util/ResourceUtil.java) | Provides methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.