KotatsuApp
/
kotatsu-parsers
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
pull/38/head
Koitharu 4 years ago
parent 7588617316
commit b632571ebc
No known key found for this signature in database
GPG Key ID: 8E861F8CE6E7CE27
1 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File

42
README.md
Unescape Escape View File

@ -2,48 +2,50 @@
Library that provides manga sources. 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 ### Usage
1. Add it in your root build.gradle at the end of repositories: 1. Add it in your root build.gradle at the end of repositories:
```groovy ```groovy
allprojects { allprojects {
repositories { repositories {
... ...
maven { url 'https://jitpack.io' } maven { url 'https://jitpack.io' }
} }
} }
``` ```
2. Add the dependency 2. Add the dependency
For Java/Kotlin project: For Java/Kotlin project:
```groovy ```groovy
dependencies { dependencies {
implementation("com.github.nv95:kotatsu-parsers:$parsers_version") implementation("com.github.KotatsuApp:kotatsu-parsers:$parsers_version")
} }
``` ```
For Android project: For Android project:
```groovy ```groovy
dependencies { dependencies {
implementation("com.github.nv95:kotatsu-parsers:$parsers_version") { implementation("com.github.KotatsuApp:kotatsu-parsers:$parsers_version") {
exclude group: 'org.json', module: 'json' 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 3. Usage in code
```kotlin ```kotlin
val parser = MangaSource.MANGADEX.newParser(mangaLoaderContext) val parser = MangaSource.MANGADEX.newParser(mangaLoaderContext)
``` ```
`mangaLoaderContext` is an implementation of the `MangaLoaderContext` class. `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. 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. Note that the `MangaSource.LOCAL` and `MangaSource.DUMMY` parsers cannot be instantiated.
Write Preview
Loading…
Cancel
Save