diff --git a/README.md b/README.md index 903d870..9cd6456 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# Macaron \ No newline at end of file +# Macaron + +Macaron is Kotlin Multiplatform MVI Framework. + +## Usage + +``` +def macaron_version = '0.0.2' + +dependencies { + implementation "tech.fika.macaron:macaron-core:$macaron_version" + implementation "tech.fika.macaron:macaron-statemachine:$macaron_version" + implementation "tech.fika.macaron:macaron-logging:$macaron_version" + implementation "tech.fika.macaron:macaron-messaging:$macaron_version" +} +```