From 852ab335cc7790cd2302ef42b062dc8a16355a4b Mon Sep 17 00:00:00 2001 From: Sultan Iskandar Maulana Date: Fri, 5 Apr 2024 08:50:47 +0000 Subject: [PATCH] Update README --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7eeb53c..a3da6fa 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,16 @@ To get the scraped data, go to [`db/`](db/) folder and download as raw. ### Examples +> [!NOTE] +> +> Final result does not contain comments, it's just for additional context in +> this README. + #### Shows -```json +```jsonc [ + // Example of a show "Shingeki no Kyojin", both season 1 and 2 { "title": "Shingeki no Kyojin", "mal_id": 16498, @@ -48,20 +54,34 @@ To get the scraped data, go to [`db/`](db/) folder and download as raw. ] ``` +To construct to a link, you can use the following format: + +```text +https://trakt.tv/{type}/{guessed_slug}/seasons/{season} +``` + #### Movies -```json +```jsonc [ + // Example of a movie "Kimi no Na wa." { "title": "Kimi no Na wa.", "mal_id": 32281, "trakt_id": 1402, + // Guessed slug won't work for movies, see additional comment "guessed_slug": "your-name", "type": "movies" } ] ``` +To construct to a link, you can use the following format: + +```text +https://trakt.tv/{type}/{guessed_slug}-{year, see additional comment} +``` + ## Additional Comment ### Guessed Slug @@ -70,7 +90,7 @@ To get the scraped data, go to [`db/`](db/) folder and download as raw. * If you're unsure about the slug, you can use the `trakt_id` to get the correct slug from the Trakt website. It's still works anyhow. * Title that is purely numerical will be nulled in the `guessed_slug` to avoid - unnecessary clash with Trakt server. + unnecessary clash with Trakt server thought it's a Trakt integer ID. * Guessed slug **won't work** for movies unless you suffixed `-{year}` to the slug manually. For example, if in the guessed slug is `your-name`, you should change it to `your-name-2016` to get the correct movie.