Skip to content

Commit 54964ee

Browse files
committed
Add LICENSE.md and README.md
1 parent 9d45ece commit 54964ee

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Christian Hughes
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Sponge Kotlin annotation Commands
2+
3+
A Kotlin-based annotation command system for the Sponge platform.
4+
5+
Commands shouldn't be verbose to set up, and this library simplifies the work into simply declaring functions.
6+
7+
## A Real World Example
8+
9+
```kotlin
10+
@Command("resident", "res")
11+
object CommandResident {
12+
13+
@Command("friend")
14+
object SubFriend {
15+
16+
@Command("add")
17+
fun add(@Source src: CommandSource, @Source srcResident: Resident, resident: Resident) {
18+
transaction(DB) {
19+
srcResident.friends = SizedCollection(srcResident.friends + resident)
20+
src.sendMessage("Added a friend: ".green() + resident.name.white())
21+
}
22+
}
23+
}
24+
}
25+
```
26+
27+
## Gradle (Kotlin DSL)
28+
29+
```kotlin
30+
repositories {
31+
maven {
32+
setUrl("https://jitpack.io")
33+
}
34+
}
35+
36+
dependencies {
37+
implementation("com.github.TheFrontier:SKC:<current version>")
38+
}
39+
```

0 commit comments

Comments
 (0)