Updating README

.editorconfig

@@ -1,22 +0,0 @@
-# This is the universal Text Editor Configuration
-# for all GTNewHorizons projects
-# See: https://editorconfig.org/
-
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 4
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.{bat,ini}]
-end_of_line = crlf
-
-[*.{dtd,json,info,mcmeta,md,sh,svg,xml,xsd,xsl,yaml,yml}]
-indent_size = 2
-
-[*.lang]
-trim_trailing_whitespace = false

.github/workflows/build-and-test.yml

@@ -1,13 +0,0 @@
-
-name: Build and test
-
-on:
-  pull_request:
-    branches: [ master, main ]
-  push:
-    branches: [ master, main ]
-
-jobs:
-  build-and-test:
-    uses: GTNewHorizons/GTNH-Actions-Workflows/.github/workflows/build-and-test.yml@master
-    secrets: inherit

.github/workflows/release-tags.yml

@@ -1,14 +0,0 @@
-
-name: Release tagged build
-
-on:
-  push:
-    tags: [ '*' ]
-
-permissions:
-  contents: write
-
-jobs:
-  release-tags:
-    uses: GTNewHorizons/GTNH-Actions-Workflows/.github/workflows/release-tags.yml@master
-    secrets: inherit

LICENSE-template

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) <year> <copyright holders>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

README.md

@@ -1,2 +1,20 @@
 # CinderCore
 
+Core API for the Cinder Project
+Cinder is a project with the goal of removing the barrier of entry to modded servers. You are not strictly required to have the Cinder content mods installed to log into supported server, instead any items, blocks and entities your client fails to recognize, are packet manipulated to look like something your client can handle
+
+Use the following methods to register fallbacks for entities, items and blocks (items and blocks both count as items)
+
+```java
+// Input fields are of type Item, Item, String, String
+// Version name needs to only contain numbers and dots
+// Version is used to track in which version was feature added, to enable outdated versions of a mod to be used on login
+CinderCore.registerItemFallback(Item.getIdFromItem(itemField), Item.getIdFromItem(Items.itemField), "mod_name", "mod_version");
+
+// Fallback entity currently needs to be modded. Working on adding compatibility for vanilla entities.
+CinderCore.registerEntityFallback(YourModdedEntity.class, FallbackEntity.class, "mod_name", "mod_version");
+
+// Also supports custom fallbacks. These need to be explicitly implemented in CinderCore. Currently only implemented custom fallback is for banners. Check com.zivilon.cindercore.mixins.LOTRPatches.java for the implementation
+// More custom fallbacks can be added to LOTRPatches.java if LOTR related. If related to other mods, please create new mixin class to organize code better.
+CinderCore.registerCustomFallback(banner_id, target_id, "banner", "mod_name", "mod_version");
+```

jitpack.yml

@@ -1,2 +0,0 @@
-before_install:
-  - ./gradlew setupCIWorkspace

shortcut

@@ -1 +0,0 @@
-src/main/java/com/zivilon/cindercore/