diff --git a/README.md b/README.md index 0787b0f1d..c5eea4ac9 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,94 @@ -# Stremio - Freedom to Stream +
+ +Stremio logo + +# Stremio Web + +**Freedom to Stream** โ€” the official web UI of [Stremio](https://www.stremio.com), a modern media center that's a one-stop solution for your video entertainment. [![Build](https://github.com/Stremio/stremio-web/actions/workflows/build.yml/badge.svg)](https://github.com/Stremio/stremio-web/actions/workflows/build.yml) [![Github Page](https://img.shields.io/website?label=Page&logo=github&up_message=online&down_message=offline&url=https%3A%2F%2Fstremio.github.io%2Fstremio-web%2F)](https://stremio.github.io/stremio-web/development) +[![Version](https://img.shields.io/github/package-json/v/Stremio/stremio-web/development?label=version&color=7b5bf5)](https://github.com/Stremio/stremio-web/releases) +[![License](https://img.shields.io/github/license/Stremio/stremio-web?color=7b5bf5)](/LICENSE.md) -Stremio is a modern media center that's a one-stop solution for your video entertainment. You discover, watch and organize video content from easy to install addons. +**[๐ŸŒ Open the Web App](https://web.stremio.com)** ยท [Website](https://www.stremio.com) ยท [Report a bug](https://github.com/Stremio/stremio-web/issues/new/choose) -## Build +Stremio board -### Prerequisites +
-* Node.js 22 or higher -* [pnpm](https://pnpm.io/installation) 11 or higher +## โœจ Features -### Install dependencies +- ๐Ÿงฉ **Addon-powered** โ€” discover movies, series and channels from catalogs provided by [addons](https://web.stremio.com/#/addons) +- ๐Ÿ”„ **Sync everywhere** โ€” your library and Continue Watching follow your Stremio account across devices +- ๐Ÿ“บ **Casting** โ€” play on the big screen via Chromecast +- ๐Ÿ’ฌ **Subtitles** โ€” addon-provided or local, with customizable styling +- โŒจ๏ธ **Keyboard-first player** โ€” full playback control without touching the mouse +- ๐ŸŒ **50+ languages** โ€” community-translated via [stremio-translations](https://github.com/Stremio/stremio-translations) +- ๐Ÿ“ฑ **Installable** โ€” runs as a standalone PWA + +## ๐Ÿ“ธ Screenshots + +| Discover | Meta Details | +|:---:|:---:| +| ![Discover](/assets/screenshots/discover.png) | ![Meta Details](/assets/screenshots/metadetails.png) | + +## ๐Ÿ›  How it works + +The UI (this repo) is a React app, but the brains live in [stremio-core](https://github.com/Stremio/stremio-core) โ€” Stremio's Rust engine compiled to WebAssembly and running in a Web Worker. The UI renders state, the core computes it. Playback goes through [stremio-video](https://github.com/Stremio/stremio-video), which picks the right player implementation for the environment. + +```mermaid +flowchart LR + UI["React UI
(this repo)"] <--> Core["stremio-core
Rust โ†’ WASM, Web Worker"] + Core <--> API["Stremio API"] + Core <--> Addons["Addons"] + UI --> Video["stremio-video"] +``` + +## ๐Ÿš€ Getting started + +You'll need [Node.js](https://nodejs.org) 22+ and [pnpm](https://pnpm.io/installation) 11+. ```bash pnpm install -``` - -### Start development server - -```bash pnpm start ``` -### Production build +The dev server runs at `http://localhost:8080`. -```bash -pnpm run build -``` +| Command | Description | +|---|---| +| `pnpm start` | Development server with hot reload | +| `pnpm run start-prod` | Development server in production mode | +| `pnpm run build` | Production build | +| `pnpm test` | Run tests | +| `pnpm run lint` | Lint the source | +| `pnpm run scan-translations` | Check for missing translation keys | -### Run with Docker +### ๐Ÿณ Docker ```bash docker build -t stremio-web . docker run -p 8080:8080 stremio-web ``` -## Screenshots +## ๐Ÿค Contributing -### Board +Bug reports and pull requests are welcome โ€” [`good first issue`](https://github.com/Stremio/stremio-web/labels/good%20first%20issue) is a great place to start. Want Stremio in your language? Contribute to [stremio-translations](https://github.com/Stremio/stremio-translations). Please read the [Code of Conduct](/CODE_OF_CONDUCT.md) first. -![Board](/assets/screenshots/board.png) +## ๐Ÿงฉ Ecosystem -### Discover +| Repository | What it is | +|---|---| +| [stremio-core](https://github.com/Stremio/stremio-core) | Rust engine: state, addon protocol, library, sync | +| [stremio-video](https://github.com/Stremio/stremio-video) | Video player abstraction used by this UI | +| [stremio-translations](https://github.com/Stremio/stremio-translations) | Community translations | +| [stremio-addon-sdk](https://github.com/Stremio/stremio-addon-sdk) | Build your own addon in Node.js | -![Discover](/assets/screenshots/discover.png) +## ๐Ÿ’ฌ Community -### Meta Details +[Website](https://www.stremio.com) ยท [Blog](https://blog.stremio.com) ยท [Reddit](https://www.reddit.com/r/Stremio) ยท [X](https://x.com/stremio) ยท [Help center](https://stremio.zendesk.com/hc/en-us) -![Meta Details](/assets/screenshots/metadetails.png) +## ๐Ÿ“„ License -## License - -Stremio is copyright 2017-2023 Smart code and available under GPLv2 license. See the [LICENSE](/LICENSE.md) file in the project for more information. +Copyright ยฉ 2017-2026 Smart Code OOD. Released under the GPL-2.0 license โ€” see [LICENSE](/LICENSE.md). diff --git a/assets/screenshots/board.png b/assets/screenshots/board.png index 8a54886f7..5cb5c55b1 100644 Binary files a/assets/screenshots/board.png and b/assets/screenshots/board.png differ diff --git a/assets/screenshots/board_wide.webp b/assets/screenshots/board_wide.webp index 211db49ec..802a5e54a 100644 Binary files a/assets/screenshots/board_wide.webp and b/assets/screenshots/board_wide.webp differ diff --git a/assets/screenshots/discover.png b/assets/screenshots/discover.png index 53f03a3e1..c3f9fee27 100644 Binary files a/assets/screenshots/discover.png and b/assets/screenshots/discover.png differ diff --git a/assets/screenshots/metadetails.png b/assets/screenshots/metadetails.png index ff0abe6f8..e6481418e 100644 Binary files a/assets/screenshots/metadetails.png and b/assets/screenshots/metadetails.png differ