From 15a764a66a01a27f5e5195442c9a6472af8d6303 Mon Sep 17 00:00:00 2001
From: Iltotore <rafbodaha@gmail.com>
Date: Thu, 23 Jul 2020 14:57:33 +0200
Subject: [PATCH] Add project's README

Signed-off-by: Iltotore <rafbodaha@gmail.com>
---
 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..e0f9b48
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# SpigotScala
+Extends the Spigot API using Scala.
+
+# Description
+SpigotScala is a Scala-specific rework of the Spigot API. It includes syntactic sugar and scala-specific features.
+
+# Features
+SpigotScala includes:
+- Scala plugin wrapper as a Spigot plugin
+- [Factory methods sugaring using the `apply` method](https://github.com/Iltotore/SpigotScala/wiki/Factory-methods)
+- [Method aliases (like operators for arithmetic methods)](https://github.com/Iltotore/SpigotScala/wiki/Decorators)
+- [Better generic support and removal of class parameters](https://github.com/Iltotore/SpigotScala/wiki/Decorators#better-generics)
+- [Usage of Scala implicits to extend existing classes](https://github.com/Iltotore/SpigotScala/wiki/Decorators)
+- [Custom DSLs](https://github.com/Iltotore/SpigotScala/wiki/DSL)
+
+# Installation
+## Developers
+You can add the [release jar](https://github.com/Iltotore/SpigotScala/releases) to your project libraries
+or use a build tool like Gradle or SBT:
+
+<details>
+<summary>Using Gradle</summary>
+
+```gradle
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation 'io.github.iltotore:spigot-scala_2.13:version'
+}
+```
+</details>
+
+<details>
+<summary>Using SBT</summary>
+
+```sbt
+libraryDependencies += "io.github.iltotore" %% "spigot-scala" % "version"
+```
+</details>
+
+## Server owners
+You must add the [release jar](https://github.com/Iltotore/SpigotScala/releases) to your `plugins` directory, then restart/reload the server.
\ No newline at end of file