diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index 78738039..35a71553 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -1,31 +1,30 @@ -### 🌸 Anilist watch list and reading list" - -The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account. - + - + + + + + + + + + + + + + + +
-
For anime watchers - -
-
For manga readers - -
-
Favorites characters - -
- -

🌸 Anilist watch list and reading list

This plugin lets you display your favorites animes, mangas and characters from your AniList account.

+
Supported features
→ Full specification		📗 Classic template
👤 Users đŸ‘Ĩ Organizations
No tokens are required for this plugin
+
For anime watchers
+
For manga readers
+
For waifus simp
+ +
+ -This plugin is composed of the following sections, which can be displayed or hidden through `plugin_anilist_sections` option: -- `favorites` will display your favorites mangas and animes -- `watching` will display animes currently in your watching list -- `reading` will display manga currently in your reading list -- `characters` will display characters you liked - -These sections can also be filtered by media type, which can be either `anime`, `manga` or both. - -#### ➡ī¸ Available options +## ➡ī¸ Available options @@ -34,7 +33,7 @@ These sections can also be filtered by media type, which can be either `anime`, - @@ -44,7 +43,7 @@ These sections can also be filtered by media type, which can be either `anime`, - @@ -56,7 +55,13 @@ These sections can also be filtered by media type, which can be either `anime`, - @@ -68,7 +73,7 @@ These sections can also be filtered by media type, which can be either `anime`, - @@ -76,11 +81,12 @@ These sections can also be filtered by media type, which can be either `anime`, (0 ≤ đ‘Ĩ)
+zero behaviour: disable
default: 2
- @@ -88,11 +94,12 @@ These sections can also be filtered by media type, which can be either `anime`, (0 ≤ đ‘Ĩ)
+zero behaviour: disable
default: 22
- @@ -113,9 +120,7 @@ These sections can also be filtered by media type, which can be either `anime`,
plugin_anilist

Display data from your AniList account

+

Enable aniList plugin
plugin_anilist_medias

Medias types to display

+

Display medias types
plugin_anilist_sections

Sections to display

+

Displayed sections

+
    +
  • favorites will display favorites plugin_anilist_medias
    • +
  • watching will display animes currently in watching list
    • +
  • reading will display manga currently in reading list
    • +
  • characters will display liked characters
    • +
plugin_anilist_limit

Maximum number of entries to display per section

+

Display limit (medias)
plugin_anilist_limit_characters

Maximum number of entries to display in characters section

+

Display limit (characters)
plugin_anilist_shuffle

Shuffle AniList data

+

Shuffle data for varied outputs
-*[→ Full specification](metadata.yml)* - -#### ℹī¸ Examples workflows +## ℹī¸ Examples workflows ```yaml @@ -156,4 +161,4 @@ with: plugin_anilist_limit_characters: 22 ``` - \ No newline at end of file + diff --git a/source/plugins/anilist/metadata.yml b/source/plugins/anilist/metadata.yml index f9cc0f80..3c6397fc 100644 --- a/source/plugins/anilist/metadata.yml +++ b/source/plugins/anilist/metadata.yml @@ -1,5 +1,10 @@ name: "🌸 Anilist watch list and reading list" category: social +description: This plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account. +examples: + +for anime watchers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg + +for manga readers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg + +for waifus simp: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg index: 4 supports: - user @@ -7,15 +12,13 @@ supports: scopes: [] inputs: - # Enable or disable plugin plugin_anilist: - description: Display data from your AniList account + description: Enable aniList plugin type: boolean default: no - # Types of medias to display plugin_anilist_medias: - description: Medias types to display + description: Display medias types type: array format: comma-separated default: anime, manga @@ -23,43 +26,42 @@ inputs: - anime - manga - # Sections to display - # Values from "plugin_anilist_medias" may impact displayed sections plugin_anilist_sections: - description: Sections to display + description: | + Displayed sections + - `favorites` will display favorites `plugin_anilist_medias` + - `watching` will display animes currently in watching list + - `reading` will display manga currently in reading list + - `characters` will display liked characters type: array format: comma-separated default: favorites example: favorites, watching, characters values: - - favorites # Favorites animes and mangas (depending on plugin_anilist_medias values) - - watching # Animes in your watching list - - reading # Mangas in your reading list - - characters # Favorites characters + - favorites + - watching + - reading + - characters - # Number of entries to display per section (this does not impacts characters section) - # Set to 0 to disable limitations plugin_anilist_limit: - description: Maximum number of entries to display per section + description: Display limit (medias) type: number default: 2 min: 0 + zero: disable - # Number of entries to display in characters section - # Set to 0 to disable limitations plugin_anilist_limit_characters: - description: Maximum number of entries to display in characters section + description: Display limit (characters) type: number default: 22 min: 0 + zero: disable - # Shuffle AniList data for varied outputs plugin_anilist_shuffle: - description: Shuffle AniList data + description: Shuffle data for varied outputs type: boolean default: yes - # Username on AniList plugin_anilist_user: type: string description: AniList login