From 915f1face7194741408a30b3c6873da1b709d317 Mon Sep 17 00:00:00 2001 From: Guilherme Pimenta Date: Tue, 15 Oct 2024 18:01:03 -0300 Subject: [PATCH] update readme instructions for installations --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d95de40..64995e1 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,25 @@ Licensed under [MIT][1]. ## Installation / Getting started -- Clone the repository from github: `git clone https://github.com/topsort/topsort.kt.git` -- From Android Studio, import the module: `File -> New -> Import Module`. -- A popup window will open with the title: Import Module From Source -- Select the source directory of the downloaded library named: `TopsortAnalytics`, and click finish -- Right click on the application project module, from the menu select `Open module Settings` -- From the left side of the displayed panel select `dependencies` -- Under `Modules` select the application module -- Under `Declared Dependencies`, click the `+` button, and select `Module Dependency` -- A popup will show up, select `TopsortAnalytics`, and at the bottom of the dialog select the type of configuration as `implementation`, then click ok +We recommend installing the library via Gradle. +Simply add the dependency to your build.gradle file: + +```gradle +dependencies { + ... + + implementation 'com.topsort:topsort-kt:1.1.0' +} +``` + +The library is distributed through Maven central, which is usually included by default in your repositories. +You can also add it directly, if needed: + +```gradle +repositories { + mavenCentral() +} +``` ## Usage/Examples