Skip to content

Commit

Permalink
chore: update readmes and add stremio homepage
Browse files Browse the repository at this point in the history
Signed-off-by: Lachezar Lechev <[email protected]>
  • Loading branch information
elpiel committed Jan 12, 2024
1 parent 60e7214 commit 2b707b6
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 1 deletion.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,68 @@ Besides changing this module, you have to update all it's dependant packages, mo

* 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**

# Release new version

## Version 1.XX.XX
To release a new version for v1 **npm** package you need to:

1. Bump [`package.json`](./package.json)
1.1. Make sure to update [`package-lock.json`](./package-lock.json):
`npm i --package-lock-only`
2. Make a new tag

`git tag -a v1.XX.XX -m "Tag for releases v1.XX.XX"`

3. Push it to the repo

`git push -u origin v1.XX.XX`

4. 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.

5. The [`publish` workflow](./.github/workflows/publish.yml) will run the `v1` job and will:
1. Build [`stremio-official-addons@1`][v1-npm-link] package
2. Publish the [package on npm][v1-npm-link]

## Version 2.XX.XX

To release a new version for v2 **npm** and **crate** packages you need to:
1. Bump [`official-addons-v2/package.json`](./official-addons-v2/package.json)
1.1. Make sure to update [`package-lock.json`](./package-lock.json):

`npm i --package-lock-only`

2. Bump [`official-addons-v2/Cargo.toml`](./official-addons-v2/Cargo.toml)
2.1. Make sure to update [`Cargo.lock`](./Cargo.lock):

`cargo update -p stremio-official-addons`

3. Make a new tag

`git tag -a v2.XX.XX -m "Tag for releases v2.XX.XX"`

4. Push it to the repo

`git push -u origin v2.XX.XX`

5. 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.

6. The [`publish` workflow](./.github/workflows/publish.yml) will run the `v2` job and will:
1. Build [`@stremio/stremio-official-addons@2`][v2-npm-link] package
2. Publish the [package on npm][v2-npm-link]
3. Publish the [crate on crates.io][v2-crates-io-link]

# License

Both packages are licensed under the MIT license:
- [`stremio-official-addons` v1 MIT license](./LICENSE.md)
- [`stremio-official-addons` v2 MIT license](./official-addons-v2/LICENSE.md)

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the project by you, shall be licensed as MIT,
without any additional terms or conditions.

[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

Expand Down
1 change: 1 addition & 0 deletions official-addons-v2/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ edition = "2018"
license = "MIT"
readme = "README.md"
repository = "https://github.com/Stremio/stremio-official-addons"
homepage = "https://stremio.com"
include = [
"/src/**/*.rs",
"/Cargo.toml",
Expand Down
3 changes: 3 additions & 0 deletions official-addons-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ To change what's contained in this module, you have to change `scripts/build.js`

Besides changing this module, you have to update all it's dependant packages.

# License

This project is licensed under the [MIT license](./LICENSE.md).

[v2-npm-link]: https://www.npmjs.com/package/@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
Expand Down
1 change: 1 addition & 0 deletions official-addons-v2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "@stremio/stremio-official-addons",
"version": "2.0.12",
"description": "All of the stremio official addons",
"homepage": "https://stremio.com",
"author": "Smart Code OOD",
"main": "addons.json",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"bugs": {
"url": "https://github.com/Stremio/stremio-official-addons/issues"
},
"homepage": "https://github.com/Stremio/stremio-official-addons#readme",
"homepage": "https://stremio.com",
"devDependencies": {
"stremio-addon-client": "^1.5.2",
"stremio-local-addon": "https://[email protected]/Stremio/stremio-local-addon#79cd88c32aa26270af8b662fa7bd92b657f6e14f"
Expand Down

0 comments on commit 2b707b6

Please sign in to comment.