stremio-official-addons 1.5.5 → 1.5.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,26 +1,26 @@
1
- The MIT License (MIT)
2
- =====================
3
-
4
- Copyright © 2019 SmartCode OOD
5
-
6
- Permission is hereby granted, free of charge, to any person
7
- obtaining a copy of this software and associated documentation
8
- files (the “Software”), to deal in the Software without
9
- restriction, including without limitation the rights to use,
10
- copy, modify, merge, publish, distribute, sublicense, and/or sell
11
- copies of the Software, and to permit persons to whom the
12
- Software is furnished to do so, subject to the following
13
- conditions:
14
-
15
- The above copyright notice and this permission notice shall be
16
- included in all copies or substantial portions of the Software.
17
-
18
- THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25
- OTHER DEALINGS IN THE SOFTWARE.
26
-
1
+ The MIT License (MIT)
2
+ =====================
3
+
4
+ Copyright © 2019 SmartCode OOD
5
+
6
+ Permission is hereby granted, free of charge, to any person
7
+ obtaining a copy of this software and associated documentation
8
+ files (the “Software”), to deal in the Software without
9
+ restriction, including without limitation the rights to use,
10
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the
12
+ Software is furnished to do so, subject to the following
13
+ conditions:
14
+
15
+ The above copyright notice and this permission notice shall be
16
+ included in all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25
+ OTHER DEALINGS IN THE SOFTWARE.
26
+
package/README.md CHANGED
@@ -1,46 +1,115 @@
1
- # stremio-official-addons
2
- [![npm][stremio-official-addons version badge]][v1-npm-link] ![downloads][stremio-official-addons downloads badge]
3
-
4
- [![npm][@stremio/stremio-official-addons version badge]][v2-npm-link] ![downloads][@stremio/stremio-official-addons downloads badge] [![crates.io version badge][crates version]][v2-crates-io-link] ![Crates.io Downloads (latest version)][crates.io downloads badge]
5
-
6
- All the stremio official add-ons, in `AddonCollection.load()` format
7
-
8
- The `index.js` file is meant to be generated from the output of `AddonCollection.save()`
9
-
10
-
11
- ## Update
12
-
13
- 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))
14
-
15
-
16
- ## Changing the official add-ons
17
-
18
- To change what's contained in this module, you have to change `scripts/gen.js`
19
-
20
- Besides changing this module, you have to update all it's dependant packages, most notably:
21
-
22
- * 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
23
-
24
- * stremio: the desktop/web app ([`stremio-official-addons@1`](https://www.npmjs.com/package/stremio-official-addons) package)
25
-
26
- * stremio-rn: the react native app
27
-
28
- * stremio-web: the new desktop/web app ([`@stremio/stremio-official-addons@2`](https://www.npmjs.com/package/@stremio/stremio-official-addons) package)
29
-
30
- * 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
31
-
32
- [v1-npm-link]: https://www.npmjs.com/package/stremio-official-addons
33
- [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
34
-
35
-
36
- [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
37
-
38
- [v2-npm-link]: https://www.npmjs.com/package/@stremio/stremio-official-addons
39
- [@stremio/stremio-official-addons downloads badge]: https://img.shields.io/npm/dm/%40stremio/stremio-official-addons?label=%40stremio%2Fstremio-official-addons%20downloads&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40stremio%2Fstremio-official-addons
40
-
41
- [@stremio/stremio-official-addons version badge]: https://img.shields.io/npm/v/%40stremio/stremio-official-addons?label=%40stremio%2Fstremio-official-addons&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40stremio%2Fstremio-official-addons
42
-
43
-
44
- [v2-crates-io-link]: https://crates.io/crates/stremio-official-addons
45
- [crates version]: https://img.shields.io/crates/v/stremio-official-addons
1
+ # stremio-official-addons
2
+ [![npm][stremio-official-addons version badge]][v1-npm-link] ![downloads][stremio-official-addons downloads badge]
3
+
4
+ [![npm][@stremio/stremio-official-addons version badge]][v2-npm-link] ![downloads][@stremio/stremio-official-addons downloads badge] [![crates.io version badge][crates version]][v2-crates-io-link] ![Crates.io Downloads (latest version)][crates.io downloads badge]
5
+
6
+ All the stremio official add-ons, in `AddonCollection.load()` format
7
+
8
+ The `index.js` file is meant to be generated from the output of `AddonCollection.save()`
9
+
10
+
11
+ ## Changing the official add-ons
12
+
13
+ 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**.
14
+
15
+ Besides changing this module, you have to update all it's dependant packages, most notably:
16
+
17
+ * 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)
18
+
19
+ * stremio: the desktop/web app ([`stremio-official-addons@1` package][v1-npm-link])
20
+
21
+ * stremio-rn: the react native app ([`stremio-official-addons@1` package][v1-npm-link])
22
+
23
+ * stremio-web: the new desktop/web app ([`@stremio/stremio-official-addons@2` package][v2-npm-link])
24
+
25
+ * stremio-core: the core for most applications including web, android tv, android, etc. ([`stremio-official-addons@2` crate][v2-crates-io-link])
26
+
27
+ * 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**
28
+
29
+ # Release new version
30
+
31
+ ## Version 1.XX.XX
32
+ To release a new version for v1 **npm** package you need to:
33
+
34
+ 1. Bump [`package.json`](./package.json)
35
+
36
+ 1.1. Make sure to update [`package-lock.json`](./package-lock.json):
37
+
38
+ `npm i --package-lock-only`
39
+
40
+ 2. Commit and push the changes to the `master` branch
41
+ **A PR is encouraged to double check if all files have been properly updated**
42
+
43
+ 3. Make a new tag
44
+
45
+ `git tag -a v1.XX.XX -m "Tag for releases v1.XX.XX"`
46
+
47
+ 4. Push it to the repo
48
+
49
+ `git push -u origin v1.XX.XX`
50
+
51
+ 5. Create a [new release](https://github.com/Stremio/stremio-official-addons/releases) using the version as a title, e.g. `v1.5.6` and automatically generate changes from previous tag.
52
+
53
+ 6. The [`publish` workflow](./.github/workflows/publish.yml) will run the `v1` job and will:
54
+ 1. Build [`stremio-official-addons@1`][v1-npm-link] package
55
+ 2. Publish the [package on npm][v1-npm-link]
56
+
57
+ ## Version 2.XX.XX
58
+
59
+ To release a new version for v2 **npm** and **crate** packages you need to:
60
+ 1. Bump [`official-addons-v2/package.json`](./official-addons-v2/package.json)
61
+
62
+ 1.1. Make sure to update [`package-lock.json`](./package-lock.json):
63
+
64
+ `npm i --package-lock-only`
65
+
66
+ 2. Bump [`official-addons-v2/Cargo.toml`](./official-addons-v2/Cargo.toml)
67
+
68
+ 2.1. Make sure to update [`Cargo.lock`](./Cargo.lock):
69
+
70
+ `cargo update -p stremio-official-addons`
71
+
72
+ 3. Commit and push the changes to the `master` branch
73
+ **A PR is encouraged to double check if all files have been properly updated**
74
+
75
+ 4. Make a new tag
76
+
77
+ `git tag -a v2.XX.XX -m "Tag for releases v2.XX.XX"`
78
+
79
+ 5. Push it to the repo
80
+
81
+ `git push -u origin v2.XX.XX`
82
+
83
+ 6. Create a [new release](https://github.com/Stremio/stremio-official-addons/releases) using the version as a title, e.g. `v2.0.12` and automatically generate changes from previous tag.
84
+
85
+ 6. The [`publish` workflow](./.github/workflows/publish.yml) will run the `v2` job and will:
86
+ 1. Build [`@stremio/stremio-official-addons@2`][v2-npm-link] package
87
+ 2. Publish the [package on npm][v2-npm-link]
88
+ 3. Publish the [crate on crates.io][v2-crates-io-link]
89
+
90
+ # License
91
+
92
+ Both packages are licensed under the MIT license:
93
+ - [`stremio-official-addons` v1 MIT license](./LICENSE.md)
94
+ - [`stremio-official-addons` v2 MIT license](./official-addons-v2/LICENSE.md)
95
+
96
+ ### Contribution
97
+
98
+ Unless you explicitly state otherwise, any contribution intentionally submitted
99
+ for inclusion in the project by you, shall be licensed as MIT,
100
+ without any additional terms or conditions.
101
+
102
+ [v1-npm-link]: https://www.npmjs.com/package/stremio-official-addons
103
+ [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
104
+
105
+ [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
106
+
107
+ [v2-npm-link]: https://www.npmjs.com/package/@stremio/stremio-official-addons
108
+ [@stremio/stremio-official-addons downloads badge]: https://img.shields.io/npm/dm/%40stremio/stremio-official-addons?label=%40stremio%2Fstremio-official-addons%20downloads&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40stremio%2Fstremio-official-addons
109
+
110
+ [@stremio/stremio-official-addons version badge]: https://img.shields.io/npm/v/%40stremio/stremio-official-addons?label=%40stremio%2Fstremio-official-addons&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40stremio%2Fstremio-official-addons
111
+
112
+
113
+ [v2-crates-io-link]: https://crates.io/crates/stremio-official-addons
114
+ [crates version]: https://img.shields.io/crates/v/stremio-official-addons
46
115
  [crates.io downloads badge]: https://img.shields.io/crates/dv/stremio-official-addons?label=Crates.io%20downloads%20(latest%20version)
package/index.js CHANGED
@@ -1 +1 @@
1
- module.exports = require('./index.json')
1
+ module.exports = require('./index.json')