-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added readme description and get ready for release
- Loading branch information
Showing
1 changed file
with
70 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,72 @@ | ||
# Kommand | ||
|
||
A description will be provided. | ||
Kommand is a lightweight, declarative command framework written in Kotlin. You can declare command models vie annotations. | ||
The commands will be executed through reflections. | ||
|
||
## Example | ||
|
||
Here is an example of a command model. | ||
```kotlin | ||
package de.tammo.kommand.test | ||
|
||
import de.tammo.kommand.annotation.Model | ||
import de.tammo.kommand.annotation.Parameter | ||
import de.tammo.kommand.annotation.Parameters | ||
import de.tammo.kommand.annotation.Route | ||
|
||
@Model("test", ["alias"], [SubTestCommand::class]) | ||
class TestCommand { | ||
|
||
@Route(description = "Default route of the test command") | ||
fun default() = true | ||
|
||
@Route("parameter", "Route with parameters") | ||
@Parameters([ | ||
Parameter("test", String::class), | ||
Parameter("optional", String::class, optional = true) | ||
]) | ||
fun parameter(test: String, optional: String?) = true | ||
|
||
} | ||
``` | ||
|
||
And this is how you register and execute them: | ||
```kotlin | ||
package de.tammo.kommand.test.executor | ||
|
||
import de.tammo.kommand.executor.CommandExecutor | ||
import org.junit.jupiter.api.Assertions.* | ||
import org.junit.jupiter.api.BeforeAll | ||
import org.junit.jupiter.api.Test | ||
import org.junit.jupiter.api.TestInstance | ||
|
||
class CommandExecutorTest { | ||
|
||
fun composeCommand() = CommandExecutor.INSTANCE.register(listOf(TestCommand::class.java)) | ||
|
||
fun execute() = CommandExecutor.INSTANCE.execute("test") | ||
|
||
} | ||
``` | ||
|
||
Look in the unit tests to see more examples. | ||
|
||
## Build with Gradle | ||
|
||
You have to add the `jitpack` repository: | ||
|
||
```groovy | ||
repository { | ||
maven { | ||
url 'https://jitpack.io' | ||
} | ||
} | ||
``` | ||
|
||
Add the dependency: | ||
|
||
```groovy | ||
dependencies { | ||
implementation("com.github.Tammo0987:Kommand:Version") | ||
} | ||
``` |