From a506a88df074e7e25b14a1f065c94c490d30ab87 Mon Sep 17 00:00:00 2001 From: FalsePattern <30945458+FalsePattern@users.noreply.github.com> Date: Wed, 8 Jun 2022 16:01:12 +0200 Subject: [PATCH] update readme --- README.MD | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.MD b/README.MD index a086cab..32f1d75 100644 --- a/README.MD +++ b/README.MD @@ -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.