Update README.md & add LICENSE-MIT

LICENSE-MIT

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2022-2023 Ampflower
+Copyright (c) 2020-2021 Tfarcenim
+Copyright (c) 2018-2021 Brennan Ward
+
+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,16 +1,113 @@
-# Fabric Example Mod
+# QuickBench & Tweaks
 
-## Setup
+A crafting table optimisation mod, improving compute and networking performance of various crafting tables, based off
+of [Fast Workbench for Forge][FastWorkbench-curse] and [FastBench for Fabric][FastWorkbench-curse].
 
-1. Edit build.gradle and mod.json to suit your needs.
-    * The "mixins" object can be removed from mod.json if you do not need to use mixins.
-    * Please replace all occurences of "modid" with your own mod ID - sometimes, a different string may also suffice.
-2. Run the following command:
+## How does it work?
 
-```
-./gradlew idea
-```
+Inherited from Fast Workbench and FastBench,
+QuickBench caches the last used recipe within a given screen,
+and optimises the shift+click crafting to prevent executing the matrix calculation,
+reducing network traffic in the process.
+
+QuickBench also reintroduces the ability to 'learn' recipes by using them, mimicking vanilla behaviour,
+and allows you to use it solely server-side, allowing any server to add it in and benefit to everyone.
+
+This benefit is provided to various crafting tables, including ones using the vanilla classes,
+allowing modded use to be seamless as long as various mods play nicely.
+
+## Any side effects?
+
+Within Vanilla, none that I could find in use.
+With other mods, there is currently one known with Yttr, [listed below](#any-mods-it-breaks).
+
+If you find any bugs or parity issues, including mod compatibility, feel free to report it on the [issue tracker].
+
+## What mods does it work with?
+
+### Optimises
+
+- Botania's Assembly & Manufactory Halo (also fixes [upstream's #21])
+- Crafting Pad
+- Portable Tables' Crafting Table
+
+### Fixed for [upstream's #20]
+
+The crafting output slot now works with these mods, which broke with FastBench:
+
+- Yttr's Project Table
+- Tom's Storage's Crafting Terminals (note: already fairly optimised)
+- Improved Workstations' Crafting Stations
+- Enhanced Workbenches' Crafting Station
+- Enhanced Project Table
+- Crafting Craft's Inventory & Portable Crafting
+- FabricAutoCrafter
+
+### Doesn't effect:
+
+- Applied Energistics 2's Crafting Terminals (note: already optimised, never broke)
+
+## Any mods it breaks?
+
+- Yttr's Crafter Rafter (already broken in vanilla usage, amplified by FastBench & QuickBench)
+
+No other mods are known to be broken at the moment.
+If you find one QuickBench breaks, feel free to report them on the [issue tracker].
 
 ## License
 
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+This mod, QuickBench & Tweaks, is licensed under the [MIT] license, inherited from the upstreams,
+[FastWorkbench for Forge][FastWorkbench-git] and [FastBench for Fabric][FabricFastBench-git],
+made by [Shadows of Fire] and [Tfarcenim] respectively.
+
+Due to the lack of clarity from the upstream repository,
+FabricFastBench is assumed to have been licensed under the [MIT] license,
+as its upstream, FastWorkbench is licensed as [MIT],
+and the [CurseForge project][FabricFastBench-curse] claims it is also licensed as [MIT],
+unlike the [GitHub repository][FabricFastBench-git], which claims it's licensed as [CC0-1.0].
+
+It is maybe fair to assume
+that the code solely produced by [Tfarcenim] maybe used under the [CC0-1.0] when without context.
+However, given the original README.md stated that the template was under the [CC0-1.0], and everything else says [MIT],
+it should be assumed the license of choice was intended to be [MIT].
+
+Several contributions from [Ampflower] are also available under [CC0-1.0],
+and will be clearly marked in the license header of each file.
+You may freely use snippets or full copies of code solely contributed by Ampflower under the terms of the [CC0-1.0].
+If the snippets have been combined, remixed or derived from the surrounding code,
+you must assume the terms of the [MIT] license may be applied.
+
+Both the [CC0-1.0] and [MIT] licenses are provided for reference.
+
+### Disclaimer:
+
+The dates and names used within the copyright header have been reconstructed based on the licenses and git history of
+both [FastWorkbench][FastWorkbench-git] and [FastBench for Fabric][FabricFastBench-git].
+
+<!-- --- Links below --- -->
+
+[Shadows of Fire]: https://github.com/Shadows-of-Fire
+
+[Tfarcenim]: https://github.com/Tfarcenim
+
+[Ampflower]: https://github.com/Ampflower
+
+[FastWorkbench-git]: https://github.com/Shadows-of-Fire/FastWorkbench
+
+[FastWorkbench-curse]: https://www.curseforge.com/minecraft/mc-mods/fastworkbench
+
+[FabricFastBench-git]: https://github.com/Tfarcenim/FabricFastBench
+
+[FabricFastBench-curse]: https://www.curseforge.com/minecraft/mc-mods/fastbench-for-fabric
+
+[MIT]: LICENSE-MIT
+
+[CC0-1.0]: LICENSE-CC0
+
+<!-- --- Meta --- -->
+
+[issue tracker]: https://github.com/Modflower/QuickBench/issues
+
+[upstream's #20]: https://github.com/Tfarcenim/FabricFastBench/issues/20
+
+[upstream's #21]: https://github.com/Tfarcenim/FabricFastBench/issues/20