diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..929f2ce --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Christian Hughes + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..057296c --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Sponge Kotlin annotation Commands + +A Kotlin-based annotation command system for the Sponge platform. + +Commands shouldn't be verbose to set up, and this library simplifies the work into simply declaring functions. + +## A Real World Example + +```kotlin +@Command("resident", "res") +object CommandResident { + + @Command("friend") + object SubFriend { + + @Command("add") + fun add(@Source src: CommandSource, @Source srcResident: Resident, resident: Resident) { + transaction(DB) { + srcResident.friends = SizedCollection(srcResident.friends + resident) + src.sendMessage("Added a friend: ".green() + resident.name.white()) + } + } + } +} +``` + +## Gradle (Kotlin DSL) + +```kotlin +repositories { + maven { + setUrl("https://jitpack.io") + } +} + +dependencies { + implementation("com.github.TheFrontier:SKC:") +} +``` \ No newline at end of file