diff --git a/README.md b/README.md index 5d51a6a..5a9ddae 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,26 @@ This is an implementation of a finite state machine in Kotlin. The main class `SimpleStateMachine` is open and extendable, but should be usable out of the box for most use cases. +## Installing + +Add jitpack to your `build.gradle` + +```` +allprojects { + repositories { + maven { url 'https://jitpack.io' } + } +} +```` + +Then add this project as a dependency: + +```` +dependencies { + implementation 'org.tjur:simplestatemachine:Tag' +} +```` + ## How to use Create a class and extend `State`. The only method you are required to override is `process`, which is @@ -109,4 +129,4 @@ fun main(args:Array){ val stateMachine = SimpleStateMachine(StartingState::class) stateMachine.run() } -```` \ No newline at end of file +```` diff --git a/build.gradle b/build.gradle index 1698223..2c6cf1b 100644 --- a/build.gradle +++ b/build.gradle @@ -4,14 +4,14 @@ plugins { } group 'org.tjur' -version '0.9' +version '0.5' repositories { mavenCentral() } dependencies { - implementation "org.jetbrains.kotlin:kotlin-stdlib:1.1.0" + implementation "org.jetbrains.kotlin:kotlin-stdlib:1.4.10" compile "org.jetbrains.kotlin:kotlin-reflect:1.1.0" testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'