From 9ac94697fa96f34d34ae37a5ccbc73fd7a264f3a Mon Sep 17 00:00:00 2001
From: booky10 <boooky10@gmail.com>
Date: Fri, 21 Jul 2023 18:50:17 +0200
Subject: [PATCH] [skip ci] Add readme

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a37a37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# CloudProtections
+
+Minecraft paper plugin for protecting spherical/cubic regions from mobs/players. Look at the `/cprots` command ingame
+for how to use this plugin.
+
+## Download
+
+https://nightly.link/CloudCraftProjects/CloudProtections/workflows/build/master/CloudProtections-Artifacts.zip
+
+**Note: Depends on [CommandAPI](https://commandapi.jorel.dev/)
+and [CloudCore](https://github.com/CloudCraftProjects/CloudCore/).**
+
+## Using this as an API
+
+### Dependency
+
+Requires `githubUsername` and `githubPassword` (classic GitHub token with package registry access) to be set
+in `~/.gradle/gradle.properties`. Then add the following to your `build.gradle.kts`:
+
+```kotlin
+repositories {
+    maven("https://maven.pkg.github.com/CloudCraftProjects/*/") {
+        name = "github"
+        credentials(PasswordCredentials::class.java)
+    }
+}
+
+dependencies {
+    compileOnly("dev.booky:cloudprotections:{VERSION}")
+}
+```
+
+`{VERSION}` has to be replaced with the latest version from the latest available package.
+
+### Usage
+
+You can get the `ProtectionsManager` instance using bukkit's `ServicesManager`. For updating regions
+use `ProtectionsManager#updateRegions`. This instantly saves the updated regions to file. Creating a new region
+can be done using `new ProtectionRegion`. Exclusions and region flags are modifiable, the area, id and priority is not
+modifiable.
+
+## License
+
+Licensed under GPL-3.0, see [LICENSE](./LICENSE) for further information.