From 948ad035e35fa9b215b4619152101f4b39e9d1d0 Mon Sep 17 00:00:00 2001 From: python-69 <102885151+python-69@users.noreply.github.com> Date: Thu, 26 May 2022 23:08:45 -0700 Subject: [PATCH] Update README.MD Provide additional clarity of wording and consistency to the readme file. (:trolley:) + god damnit --- README.MD | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.MD b/README.MD index 3a9abe6..a086cab 100644 --- a/README.MD +++ b/README.MD @@ -1,23 +1,23 @@ A library mod for 1.7.10 with lots of useful stuff. See the table below for more information. -| Package | Stuff it has | +| Package | Contents / Purpose | |-----------------------------------------------------------------|-----------------------------------------------------------------| -| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2. | +| [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. Uses Maven. | +| [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 stuff that don't fit the above categories. See below | +| [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 | What it does | +| Class | Purpose | |--------------|----------------------------------------------------------------------------------------------------------------| -| ResourceUtil | Provides methods for efficiently retrieving resources from SPECIFIC jar files, instead of the entire classpath | +| ResourceUtil | 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. ### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask -[![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4) \ No newline at end of file +[![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4)