From ef91dafd50486a0dad14f814e8c9e005dbf048bd Mon Sep 17 00:00:00 2001 From: jopejoe1 <34899572+jopejoe1@users.noreply.github.com> Date: Fri, 28 Jan 2022 18:49:56 +1300 Subject: [PATCH] Add README files for various extensions (#10567) * Updatte Komanga readme Co-authored-by: Andreas <6576096+ghostbear@users.noreply.github.com> * Add Readme to LANraragi * Add ReadME to LANraragi * Update build.gradle * Update Komga readme * Add Kavita ReadMe * Update build.gradle * Update README.md * Add Cubari Readme * Update build.gradle * Add changelog to Cubari * Add Changelog to Kavita * Add LANraragi Changelog * Add Readme to Bato.to * Update build.gradle * Add Changelog to Bato.to * Update CHANGELOG.md * Update src/all/lanraragi/README.md Co-authored-by: Andreas * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Andreas <6576096+ghostbear@users.noreply.github.com> Co-authored-by: Andreas --- src/all/batoto/CHANGELOG.md | 141 +++++++++++++++++++++++++++++++++ src/all/batoto/README.md | 20 +++++ src/all/batoto/build.gradle | 2 +- src/all/cubari/CHANGELOG.md | 67 ++++++++++++++++ src/all/cubari/README.md | 24 ++++++ src/all/cubari/build.gradle | 2 +- src/all/kavita/CHANGELOG.md | 11 +++ src/all/kavita/README.md | 37 +++++++++ src/all/kavita/build.gradle | 2 +- src/all/komga/README.md | 19 +++-- src/all/lanraragi/CHANGELOG.md | 72 +++++++++++++++++ src/all/lanraragi/README.md | 35 ++++++++ src/all/lanraragi/build.gradle | 2 +- 13 files changed, 425 insertions(+), 9 deletions(-) create mode 100644 src/all/batoto/CHANGELOG.md create mode 100644 src/all/batoto/README.md create mode 100644 src/all/cubari/CHANGELOG.md create mode 100644 src/all/cubari/README.md create mode 100644 src/all/kavita/CHANGELOG.md create mode 100644 src/all/kavita/README.md create mode 100644 src/all/lanraragi/CHANGELOG.md create mode 100644 src/all/lanraragi/README.md diff --git a/src/all/batoto/CHANGELOG.md b/src/all/batoto/CHANGELOG.md new file mode 100644 index 000000000..54865e13d --- /dev/null +++ b/src/all/batoto/CHANGELOG.md @@ -0,0 +1,141 @@ +## 1.2.22 + +### Features + +* Add `CHANGELOG.md` & `README.md` + +## 1.2.21 + +### Fix + +* Update lang codes + +## 1.2.20 + +### Features + +* Rework of search + +## 1.2.19 + +### Features + +* Support for alternative chapter list +* Personal lists filter + +## 1.2.18 + +### Features + +* Utils lists filter +* Letter matching filter + +## 1.2.17 + +### Features + +* Add mirror `mycdhands.com` + +## 1.2.16 + +### Features + +* Mirror support +* URL intent updates + +## 1.2.15 + +### Fix + +* Manga description + +## 1.2.14 + +### Features + +* Escape entities + +## 1.2.13 + +### Refactor + +* Replace Gson with kotlinx.serialization + +## 1.2.12 + +### Fix + +* Infinity search + +## 1.2.11 + +### Fix + +* No search result + +## 1.2.10 + +### Features + +* Support for URL intent +* Updated filters + +## 1.2.9 + +### Fix + +* Chapter parsing + +## 1.2.8 + +### Features + +* More chapter filtering + +## 1.2.7 + +### Fix + +* Language filtering in latest +* Parsing of seconds + +## 1.2.6 + +### Features + +* Scanlotor support + +### Fix + +* Date parsing + +## 1.2.5 + +### Features + +* Update supported Language list + +## 1.2.4 + +### Features + +* Support for excluding genres + +## 1.2.3 + +### Fix + +* Typo in some genres + +## 1.2.2 + +### Features + +* Reworked filter option + +## 1.2.1 + +### Features + +* Conversion from Emerald to Bato.to +* First version diff --git a/src/all/batoto/README.md b/src/all/batoto/README.md new file mode 100644 index 000000000..8f7c39cc5 --- /dev/null +++ b/src/all/batoto/README.md @@ -0,0 +1,20 @@ +# Bato.to + +Table of Content +- [FAQ](#FAQ) + - [Why are there Manga of diffrent languge than the selected one in Personal & Utils lists?](#why-are-there-manga-of-diffrent-languge-than-the-selected-one-in-personal--utils-lists) + - [Bato.to is not loading anything?](#batoto-is-not-loading-anything) + +[Uncomment this if needed; and replace ( and ) with ( and )]: <> (- [Guides](#Guides)) + +Don't find the question you are look for go check out our general FAQs and Guides over at [Extension FAQ](https://tachiyomi.org/help/faq/#extensions) or [Getting Started](https://tachiyomi.org/help/guides/getting-started/#installation) + +## FAQ + +### Why are there Manga of diffrent languge than the selected one in Personal & Utils lists? +Personol & Utils lists have no way to difritiate between langueges. + +### Bato.to is not loading anything? +Bato.to get blocked by some ISPs, try using a diffrent mirror of Bato.to from the settings. + +[Uncomment this if needed]: <> (## Guides) diff --git a/src/all/batoto/build.gradle b/src/all/batoto/build.gradle index a7c94746e..74bd90a2b 100644 --- a/src/all/batoto/build.gradle +++ b/src/all/batoto/build.gradle @@ -6,7 +6,7 @@ ext { extName = 'Bato.to' pkgNameSuffix = 'all.batoto' extClass = '.BatoToFactory' - extVersionCode = 21 + extVersionCode = 22 isNsfw = true } diff --git a/src/all/cubari/CHANGELOG.md b/src/all/cubari/CHANGELOG.md new file mode 100644 index 000000000..ae1c5e216 --- /dev/null +++ b/src/all/cubari/CHANGELOG.md @@ -0,0 +1,67 @@ +## 1.2.11 + +### Features + +* Add `CHANGELOG.md` & `README.md` + +## 1.2.10 + +### Features + +* Wildcard hosts in URL intent + +## 1.2.9 + +### Fix + +* release date +* empty volume + +## 1.2.8 + +### Fix + +* Upload fate + +## 1.2.7 + +### Fix + +* proxy methode + +## 1.2.6 + +### Refactor + +* replace Gson with kotlinx.serialization + +## 1.2.5 + +### Fix + +* Volume default + +## 1.2.4 + +### Fix + +* seriesSlug being the wrong type + +## 1.2.3 + +### Features + +* Volume support +* Fall back release date + +## 1.2.2 + +### Features + +* Migrate Guya proxy to Cubari + +## 1.2.1 + +### Features + +* first version diff --git a/src/all/cubari/README.md b/src/all/cubari/README.md new file mode 100644 index 000000000..56d26d07c --- /dev/null +++ b/src/all/cubari/README.md @@ -0,0 +1,24 @@ +# Cubari + +Table of Content +- [FAQ](#FAQ) + - [Why do I see no manga?](#why-do-i-see-no-manga) + - [Where can I get more information about Cubari?](#where-can-i-get-more-information-about-cubari) + - [How do I add a gallery to Cubari?](#how-do-i-add-a-gallery-to-cubari) + +[Uncomment this if needed; and replace ( and ) with ( and )]: <> (- [Guides](#Guides)) + +Don't find the question you are look for go check out our general FAQs and Guides over at [Extension FAQ](https://tachiyomi.org/help/faq/#extensions) or [Getting Started](https://tachiyomi.org/help/guides/getting-started/#installation) + +## FAQ + +### Why do I see no manga? +Cubari is a proxy for image gallery's. + +### Where can I get more information about Cubari? +You can visit the [Cubari](https://cubari.moe/) website for for more information. + +### How do I add a gallery to Cubari? +You can directly open a imgur or Cubari link in the extension. + +[Uncomment this if needed]: <> (## Guides) diff --git a/src/all/cubari/build.gradle b/src/all/cubari/build.gradle index bfd8f31c3..b72e59b64 100644 --- a/src/all/cubari/build.gradle +++ b/src/all/cubari/build.gradle @@ -6,7 +6,7 @@ ext { extName = 'Cubari' pkgNameSuffix = "all.cubari" extClass = '.CubariFactory' - extVersionCode = 10 + extVersionCode = 11 } apply from: "$rootDir/common.gradle" diff --git a/src/all/kavita/CHANGELOG.md b/src/all/kavita/CHANGELOG.md new file mode 100644 index 000000000..3600e181b --- /dev/null +++ b/src/all/kavita/CHANGELOG.md @@ -0,0 +1,11 @@ +## 1.2.2 + +### Features + +* Add `CHANGELOG.md` & `README.md` + +## 1.2.1 + +### Features + +* first version diff --git a/src/all/kavita/README.md b/src/all/kavita/README.md new file mode 100644 index 000000000..a73efdf92 --- /dev/null +++ b/src/all/kavita/README.md @@ -0,0 +1,37 @@ +# Kavita + +Table of Content +- [FAQ](#FAQ) + - [Why do I see no manga?](#why-do-i-see-no-manga) + - [Where can I get more information about Kavita?](#where-can-i-get-more-information-about-kavita) + - [The Kavita extension stopped working?](#the-kavita-extension-stopped-working) + - [Can I add more than one Kavita server or user?](#can-i-add-more-than-one-kavita-server-or-user) + - [Can I test the Kavita extension before setting up my own server?](#can-i-test-the-kavita-extension-before-setting-up-my-own-server) +- [Guides](#Guides) + - [How do I add my Kavita server to Tachiyomi?](#how-do-i-add-my-kavita-server-to-tachiyomi) + +Don't find the question you are look for go check out our general FAQs and Guides over at [Extension FAQ](https://tachiyomi.org/help/faq/#extensions) or [Getting Started](https://tachiyomi.org/help/guides/getting-started/#installation) + +Kavita also has a documentation about the Tachiyomi Kavita extension at the [Kavita wiki](https://wiki.kavitareader.com/en/guides/plugins-and-3rd-party-scripts/tachiyomi). + +## FAQ + +### Why do I see no manga? +Kavita is a self-hosted comic/manga media server. + +### Where can I get more information about Kavita? +You can visit the [Kavita](https://www.kavitareader.com/) website for for more information. + +### The Kavita extension stopped working? +Make sure that your Kavita server and extension are on the newest version. + +### Can I add more than one Kavita server or user? +Yes, currently you can add up to 3 different Kavita instances to Tachiyomi. + +### Can I test the Kavita extension before setting up my own server? +Yes, you can try it out with the DEMO servers OPDS url `https://demo.kavitareader.com/api/opds/aca1c50d-7e08-4f37-b356-aecd6bf69b72`. + +## Guides + +### How do I add my Kavita server to Tachiyomi? +Go into the settings of the Kavita extension from the Extension tab in Browse and fill in your OPDS url. diff --git a/src/all/kavita/build.gradle b/src/all/kavita/build.gradle index 0c767f5f6..a76875a7d 100644 --- a/src/all/kavita/build.gradle +++ b/src/all/kavita/build.gradle @@ -6,7 +6,7 @@ ext { extName = 'Kavita' pkgNameSuffix = 'all.kavita' extClass = '.KavitaFactory' - extVersionCode = 1 + extVersionCode = 2 } dependencies { diff --git a/src/all/komga/README.md b/src/all/komga/README.md index ad0f37936..fa7ae9fc7 100644 --- a/src/all/komga/README.md +++ b/src/all/komga/README.md @@ -2,25 +2,34 @@ Table of Content - [FAQ](#FAQ) + - [Why do I see no manga?](#why-do-i-see-no-manga) + - [Where can I get more information about Komga?](#where-can-i-get-more-information-about-komga) + - [The Komga extension stopped working?](#the-komga-extension-stopped-working) + - [Can I add more than one Komga server or user?](#can-i-add-more-than-one-komga-server-or-user) + - [Can I test the Komga extension before setting up my own server?](#can-i-test-the-komga-extension-before-setting-up-my-own-server) - [Guides](#Guides) + - [How do I add my Komga server to Tachiyomi?](#how-do-i-add-my-komga-server-to-tachiyomi) Don't find the question you are look for go check out our general FAQs and Guides over at [Extension FAQ](https://tachiyomi.org/help/faq/#extensions) or [Getting Started](https://tachiyomi.org/help/guides/getting-started/#installation) ## FAQ -### Why do i see no manga? +### Why do I see no manga? Komga is a self-hosted comic/manga media server. -### Where can i get more information about Komga? +### Where can I get more information about Komga? You can visit the [Komga](https://komga.org/) website for for more information. ### The Komga extension stopped working? Make sure that your Komga server and extension are on the newest version. -### Can i add more than one Komga server or user? +### Can I add more than one Komga server or user? Yes, currently you can add up to 3 different Komga instances to Tachiyomi. +### Can I test the Komga extension before setting up my own server? +Yes, you can try it out with the DEMO server `https://demo.komga.org`, username `demo@komga.org` and password `komga-demo`. + ## Guides -### How do i add my Komga server to Tachiyomi? -Go into the setting menu of the Komga extension and fill in your server address and login details. +### How do I add my Komga server to Tachiyomi? +Go into the settings of the Komga extension from the Extension tab in Browse and fill in your server address and login details. diff --git a/src/all/lanraragi/CHANGELOG.md b/src/all/lanraragi/CHANGELOG.md new file mode 100644 index 000000000..6f1c1564a --- /dev/null +++ b/src/all/lanraragi/CHANGELOG.md @@ -0,0 +1,72 @@ +## 1.2.9 +Minimum LANraragi version required: 0.8.2 + +### Features + +* Add `CHANGELOG.md` & `README.md` + +## 1.2.8 +Minimum LANraragi version required: 0.8.2 + +### Fix + +* Nullpo + +### Refactor + +* replace Gson with kotlinx.serialization + +## 1.2.7 +Minimum LANraragi version required: 0.8.2 + +### Features + +* Update Icon +* Search-aware random +* API Key warnig +* Items marked as `Completed` instead of `Unknown` + +### Fix + +* Tag Separation + +## 1.2.6 + +### Fix + +* categories not appearing from large responses +* Random item visibility +* Ignore DNS over HTTPS + +## 1.2.5 + +### Features + +* Add Random entry +* Clear new status on the server + +## 1.2.4 + +### Features + +* Safer tag parsing + +## 1.2.3 + +### Features + +* Filters and pagination manipulation +* New preferences +* API usage change to use its metadata endpoint and preserve WebView + +## 1.2.2 + +### Features + +* Update to API 0.7.2 + +## 1.2.1 + +### Features + +* first version diff --git a/src/all/lanraragi/README.md b/src/all/lanraragi/README.md new file mode 100644 index 000000000..3a80ce486 --- /dev/null +++ b/src/all/lanraragi/README.md @@ -0,0 +1,35 @@ +# LANraragi + +Table of Content +- [FAQ](#FAQ) + - [Why do I see no manga?](#why-do-i-see-no-manga) + - [Where can I get more information about LANraragi?](#where-can-i-get-more-information-about-lanraragi) + - [The LANraragi extension stopped working?](#the-lanraragi-extension-stopped-working) + - [Can I add more than one LANraragi server or user?](#can-i-add-more-than-one-lanraragi-server-or-user) + - [Can I test the LANraragi extension before setting up my own server?](#can-i-test-the-lanraragi-extension-before-setting-up-my-own-server) +- [Guides](#Guides) + - [How do I add my LANraragi server to Tachiyomi?](#how-do-i-add-my-lanraragi-server-to-tachiyomi) + +Don't find the question you are look for go check out our general FAQs and Guides over at [Extension FAQ](https://tachiyomi.org/help/faq/#extensions) or [Getting Started](https://tachiyomi.org/help/guides/getting-started/#installation) + +## FAQ + +### Why do I see no manga? +LANraragi is a self-hosted comic/manga media server. + +### Where can I get more information about LANraragi? +You can visit the [LANraragi](https://github.com/Difegue/LANraragi) github page for for more information. + +### The LANraragi extension stopped working? +Make sure that your LANraragi server and extension are on the newest version. + +### Can I add more than one LANraragi server or user? +No, currently there is only support for 1 instances in Tachiyomi, if you need more instances please open a feature request on [tachiyomi-extensions](https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new?assignees=&labels=Feature+request&template=request_feature.yml) repo. + +### Can I test the LANraragi extension before setting up my own server? +Yes, you can try it out with the DEMO server `https://lrr.tvc-16.science`. + +## Guides + +### How do I add my LANraragi server to Tachiyomi? +Go into the settings of the LANraragi extension from the Extension tab in Browse and fill in your server address and API key if needed. diff --git a/src/all/lanraragi/build.gradle b/src/all/lanraragi/build.gradle index 81f26c0e0..e1a41484d 100644 --- a/src/all/lanraragi/build.gradle +++ b/src/all/lanraragi/build.gradle @@ -6,7 +6,7 @@ ext { extName = 'LANraragi' pkgNameSuffix = 'all.lanraragi' extClass = '.LANraragi' - extVersionCode = 8 + extVersionCode = 9 } dependencies {