From 0b2aa16fbf5bea73b76067612e3310242579fe96 Mon Sep 17 00:00:00 2001 From: Lachezar Lechev Date: Thu, 11 Jan 2024 12:43:50 +0200 Subject: [PATCH] chore: update README Signed-off-by: Lachezar Lechev --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5a802e0..9559b15 100644 --- a/README.md +++ b/README.md @@ -8,31 +8,27 @@ All the stremio official add-ons, in `AddonCollection.load()` format The `index.js` file is meant to be generated from the output of `AddonCollection.save()` -## Update - -To re-generate `index.json` you can do `scripts/gen.js > index.json` ( you also need a locally running Stremio Server using either the [Stremio Desktop](https://www.stremio.com/downloads) app or [Stremio service](https://www.stremio.com/download-service)) - - ## Changing the official add-ons -To change what's contained in this module, you have to change `scripts/gen.js` +To change what's contained in this module, you have to change [`scripts/gen.js`](./scripts/gen.js) for **version 1** and [`official-addons-v2/scripts/build.js`](./official-addons-v2/scripts/build.js) for **version 2**. Besides changing this module, you have to update all it's dependant packages, most notably: -* stremio-api-workers: this is the **most important one**, since it will affect `addonsofficialcollection.json` and therefore the addonCollection API, and therefore all running apps should respect it +* stremio-api-workers: this is the **most important one**, since it will affect `addonsofficialcollection.json` and therefore the addonCollection API, and therefore all running apps should respect it ([`stremio-official-addons@1`][v1-npm-link] package) -* stremio: the desktop/web app ([`stremio-official-addons@1`](https://www.npmjs.com/package/stremio-official-addons) package) +* stremio: the desktop/web app ([`stremio-official-addons@1` package][v1-npm-link]) -* stremio-rn: the react native app +* stremio-rn: the react native app ([`stremio-official-addons@1` package][v1-npm-link]) -* stremio-web: the new desktop/web app ([`@stremio/stremio-official-addons@2`](https://www.npmjs.com/package/@stremio/stremio-official-addons) package) +* stremio-web: the new desktop/web app ([`@stremio/stremio-official-addons@2` package][v2-npm-link]) -* stremio-api-legacy-shim: this one does not *depend on* this module, and does not include it, but it contains a separate list of official add-ons in `addons/official.js` that is respected by all apps using the legacy endpoints +* stremio-core: the core for most applications including web, android tv, android, etc. ([`stremio-official-addons@2` crate][v2-crates-io-link]) + +* stremio-api-legacy-shim: this one does not *depend on* this module, and does not include it, but it contains a separate list of official add-ons in `addons/official.js` that is respected by all apps using the legacy endpoints **ARCHIVED** [v1-npm-link]: https://www.npmjs.com/package/stremio-official-addons [stremio-official-addons downloads badge]: https://img.shields.io/npm/dm/stremio-official-addons?label=stremio-official-addons%20downloads&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fstremio-official-addons - [stremio-official-addons version badge]: https://img.shields.io/npm/v/stremio-official-addons?label=stremio-official-addons&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fstremio-official-addons [v2-npm-link]: https://www.npmjs.com/package/@stremio/stremio-official-addons