Add README

Author: TechnicallyCoded

README.md

@@ -0,0 +1,80 @@
+# FoliaLib
+This project is not directly affiliated with Paper team or the Folia project.
+
+## Description
+This is a wrapper library for aiding in supporting the Folia Paper Fork. This library adds multiple scheduler options to use instead of the Bukkit or Folia native schedulers. Developers are expected to depend on this library and relocate the package to their own to prevent conflicts with other plugins.
+
+Note: This project is still in its early stages and may make frequent breaking changes to the API. Additionally, I won't claim that this library is perfect; If you find any issues, please report them on the [issues page](https://github.com/TechnicallyCoded/FoliaLib/issues)
+
+## As a dependency
+### Maven
+```xml
+<repositories>
+    <repository>
+        <id>devmart-other</id>
+        <url>https://nexuslite.gcnt.net/repos/other/</url>
+    </repository>
+</repositories>
+
+<dependencies>
+    <dependency>
+        <groupId>com.tcoded</groupId>
+        <artifactId>FoliaLib</artifactId>
+        <version>[VERSION]</version>
+        <scope>compile</scope>
+    </dependency>
+</dependencies>
+```
+**!! You are expected to relocate the package "com.tcoded.folialib" to your own (ex: "me.steve.lib.folialib") to prevent conflicts with other plugins !!**
+
+***
+
+### Gradle
+```groovy
+repositories {
+    maven {
+        name = "devmart-other"
+        url = "https://nexuslite.gcnt.net/repos/other/"
+    }
+}
+
+dependencies {
+    compileOnly "com.tcoded:FoliaLib:[VERSION]"
+}
+```
+**!! You are expected to relocate the package "com.tcoded.folialib" to your own (ex: "me.steve.lib.folialib") to prevent conflicts with other plugins !!**
+
+## How to use
+Create a new instance of the FoliaLib class:
+```java
+FoliaLib foliaLib = new FoliaLib(this);
+```
+Then you can use the scheduler options:
+```java
+// Remember that 20 ticks = 1000 milliseconds, and 20 * 50L = 1000L
+
+// On a spigot server, runTimer() will run on the main thread
+// On a folia server, runTimer() will run using the AsyncScheduler
+foliaLib.getImpl().runTimer(() -> {/* Code */}, 0L, 20 * 50L, TimeUnit.MILLISECONDS);
+
+// You can also specify the thread that you want it to run on
+// On a Folia server, the SYNC option will run using the GlobalRegionScheduler 
+//   !! This does not make it safe to use for players or block changes !!
+//   Use other methods below for handling those
+//   This should only be used for updating the following (see GlobalRegionScheduler.java for more info)
+//     - world day time, world game time, weather cycle, sleep night skipping, executing commands for console, and other misc
+// On a spigot server, the SYNC option will run on the main thread
+// In both cases, the ASYNC option will run asynchronously
+foliaLib.getImpl().runTimer(ThreadScope.ASYNC, () -> {/* Code */}, 0L, 20 * 50L, TimeUnit.MILLISECONDS);
+
+// On a folia server, this will run the code using the RegionScheduler that is appropriate for the location
+// On a spigot server, this will run the code on the main thread
+foliaLib.getImpl().runInRegion(location, () -> {/* Code */});
+
+// On a folia server, you need to run code that affects a player or the world in a region.
+// On a spigot server, this will just run the code on the main thread
+foliaLib.getImpl().runInPlayerRegion(player, () -> {/* Code */});
+```
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details