diff --git a/README.md b/README.md index ac77a4d..3c215f5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,41 @@ # Eyejet Lifecycle-aware shared observable data holder class for android. +### 1. Depend on our library + +Eyejet Library is available through Maven Repository. +To use it: + +1. Open the `build.gradle` file for your application. +2. Make sure that the `repositories` section includes Maven Repository + `mavenCentral()`. For example: +```groovy + allprojects { + repositories { + mavenCentral() + } + } +``` + +3. Add the library to the `dependencies` section: +```groovy +dependencies { + // ... + + // declare eyejet version + def eyejet_version = "x.y.z" + + // Eyejet Library + implementation("com.zeoflow:eyejet:$eyejet_version") + + // Optional - the eyejet library works without these dependencies + implementation("com.zeoflow:eyejet-annotation:$eyejet_version") + implementation("com.zeoflow:eyejet-arch:$eyejet_version") + + // ... +} +``` + ## License Copyright (C) 2021 ZeoFlow S.R.L. diff --git a/docs/README.md b/docs/README.md index ac77a4d..3c215f5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,41 @@ # Eyejet Lifecycle-aware shared observable data holder class for android. +### 1. Depend on our library + +Eyejet Library is available through Maven Repository. +To use it: + +1. Open the `build.gradle` file for your application. +2. Make sure that the `repositories` section includes Maven Repository + `mavenCentral()`. For example: +```groovy + allprojects { + repositories { + mavenCentral() + } + } +``` + +3. Add the library to the `dependencies` section: +```groovy +dependencies { + // ... + + // declare eyejet version + def eyejet_version = "x.y.z" + + // Eyejet Library + implementation("com.zeoflow:eyejet:$eyejet_version") + + // Optional - the eyejet library works without these dependencies + implementation("com.zeoflow:eyejet-annotation:$eyejet_version") + implementation("com.zeoflow:eyejet-arch:$eyejet_version") + + // ... +} +``` + ## License Copyright (C) 2021 ZeoFlow S.R.L.