Skip to content

Commit

Permalink
Release 0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
bladh committed Sep 28, 2021
1 parent 641be6f commit 4b683c4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -109,4 +129,4 @@ fun main(args:Array<String>){
val stateMachine = SimpleStateMachine(StartingState::class)
stateMachine.run()
}
````
````
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit 4b683c4

Please sign in to comment.