From b632571ebcd6d6afd23c31a0f6dc6a0c78e93029 Mon Sep 17 00:00:00 2001 From: Koitharu Date: Thu, 28 Jul 2022 10:04:07 +0300 Subject: [PATCH] Update readme --- README.md | 52 +++++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 4987e162..504c9d0a 100644 --- a/README.md +++ b/README.md @@ -2,48 +2,50 @@ Library that provides manga sources. -[![](https://jitpack.io/v/nv95/kotatsu-parsers.svg)](https://jitpack.io/#nv95/kotatsu-parsers) ![Kotlin](https://img.shields.io/github/languages/top/nv95/kotatsu-parsers) ![License](https://img.shields.io/github/license/nv95/Kotatsu) [![Discord](https://img.shields.io/discord/898363402467045416?color=5865f2&label=discord)](https://discord.gg/NNJ5RgVBC5) +[![](https://jitpack.io/v/KotatsuApp/kotatsu-parsers.svg)](https://jitpack.io/#KotatsuApp/kotatsu-parsers) ![Kotlin](https://img.shields.io/github/languages/top/KotatsuApp/kotatsu-parsers) ![License](https://img.shields.io/github/license/KotatsuApp/Kotatsu) [![Discord](https://img.shields.io/discord/898363402467045416?color=5865f2&label=discord)](https://discord.gg/NNJ5RgVBC5) ### Usage 1. Add it in your root build.gradle at the end of repositories: - ```groovy - allprojects { - repositories { - ... - maven { url 'https://jitpack.io' } - } - } - ``` + ```groovy + allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } + } + ``` -2. Add the dependency +2. Add the dependency - For Java/Kotlin project: + For Java/Kotlin project: ```groovy dependencies { - implementation("com.github.nv95:kotatsu-parsers:$parsers_version") + implementation("com.github.KotatsuApp:kotatsu-parsers:$parsers_version") } ``` - - For Android project: + + For Android project: ```groovy dependencies { - implementation("com.github.nv95:kotatsu-parsers:$parsers_version") { + implementation("com.github.KotatsuApp:kotatsu-parsers:$parsers_version") { exclude group: 'org.json', module: 'json' } } ``` - - See for versions at [JitPack](https://jitpack.io/#nv95/kotatsu-parsers) - + + See for versions at [JitPack](https://jitpack.io/#KotatsuApp/kotatsu-parsers) + 3. Usage in code - ```kotlin - val parser = MangaSource.MANGADEX.newParser(mangaLoaderContext) - ``` - - `mangaLoaderContext` is an implementation of the `MangaLoaderContext` class. - See [Android](https://github.com/nv95/Kotatsu/blob/devel/app/src/main/java/org/koitharu/kotatsu/core/parser/MangaLoaderContextImpl.kt) and [Non-Android](https://github.com/nv95/kotatsu-dl/blob/master/src/main/kotlin/org/koitharu/kotatsu_dl/env/MangaLoaderContextImpl.kt) implementation examples. + ```kotlin + val parser = MangaSource.MANGADEX.newParser(mangaLoaderContext) + ``` + + `mangaLoaderContext` is an implementation of the `MangaLoaderContext` class. + See [Android](https://github.com/KotatsuApp/Kotatsu/blob/devel/app/src/main/java/org/koitharu/kotatsu/core/parser/MangaLoaderContextImpl.kt) + and [Non-Android](https://github.com/KotatsuApp/kotatsu-dl/blob/master/src/main/kotlin/org/koitharu/kotatsu_dl/env/MangaLoaderContextImpl.kt) + implementation examples. - Note that the `MangaSource.LOCAL` and `MangaSource.DUMMY` parsers cannot be instantiated. \ No newline at end of file + Note that the `MangaSource.LOCAL` and `MangaSource.DUMMY` parsers cannot be instantiated. \ No newline at end of file