diff --git a/README.md b/README.md index 2dec6d07..417ca723 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,25 @@
- Yattee logo

Yattee

-

Privacy-focused video player for iPhone, iPad, Mac, and Apple TV

+

Privacy oriented video player for iOS, tvOS and macOS

[![AGPL v3](https://shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html) [![GitHub issues](https://img.shields.io/github/issues/yattee/yattee)](https://github.com/yattee/yattee/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/yattee/yattee)](https://github.com/yattee/yattee/pulls) -[![Discord](https://invidget.switchblade.xyz/pSnNKhZHEG)](https://yattee.stream/discord) +[![Discord](https://invidget.switchblade.xyz/pSnNKhZHEG)](https://yattee.stream/discord)
-## Install - - - TestFlight - - -[Join the TestFlight beta](https://yattee.stream/beta2) - - - - +> **Yattee 2 is in the works!** A new version of the app is being built with a refreshed experience. +> It pairs with the new [Yattee Server](https://github.com/yattee/yattee-server) — a self-hosted backend powered by yt-dlp that supports 1000+ sites. +> Join the [TestFlight beta](https://yattee.stream/beta2) to try early builds, and check the new documentation site at [docs.yattee.stream](https://docs.yattee.stream) for guides, roadmap and changelog. ## Features - -**Playback** -- 4K video with custom MPV-based player (H.264, H.265, VP9, AV1) -- Picture in Picture, background audio, fullscreen -- Playback queue, history, resume from last position -- Chapter navigation, playback speed, subtitles and captions -- Gesture controls (seek, volume, brightness) -- Seek preview with storyboards - -**Content Sources** -- YouTube via Invidious, Piped, or self-hosted Yattee Server -- PeerTube instances (federated video) -- Local files, SMB network shares, WebDAV servers - -**Integrations** -- [SponsorBlock](https://sponsor.ajay.app/) (configurable skip categories) -- [DeArrow](https://dearrow.ajay.app/) (crowdsourced titles and thumbnails) -- [Return YouTube Dislike](https://returnyoutubedislike.com/) - -**Privacy** -- No tracking, no ads, no account required -- All traffic goes through your chosen instances - -**Library** -- Subscriptions with per-channel notifications -- Bookmarks with tags and notes, playlists, watch history -- Unified search across all configured sources -- Import/export subscriptions (JSON, CSV, OPML) - -**Downloads & Sync** -- Offline video and audio downloads with quality selection -- iCloud sync for bookmarks, subscriptions, history, and settings across devices -- Handoff continuity between iPhone, iPad, Mac, and Apple TV - -**Apple Ecosystem** -- iOS 18+ / macOS 15+ / tvOS 18+ -- Native SwiftUI on every platform -- Customizable home layout, accent colors, player controls, and app icon -- Clipboard URL detection and deep linking (`yattee://`) -- Remote control between devices on your network - -## Yattee Server - -A self-hosted backend powered by [yt-dlp](https://github.com/yt-dlp/yt-dlp) that gives Yattee superpowers. - -- **Direct stream URLs** — gets fresh YouTube CDN URLs, bypassing Invidious/Piped blocks and rate limits -- **Play from 1000+ sites** — Vimeo, TikTok, Twitch, Dailymotion, Twitter/X, and anything else yt-dlp supports -- **Invidious-compatible API** — drop-in replacement, works alongside existing Invidious/Piped instances -- **Self-hosted & private** — run on your own hardware, no data leaves your network -- **Fast parallel streaming** — yt-dlp parallel downloading streams video while it downloads -- **Admin panel** — web UI for settings, credentials, and monitoring -- **Docker ready** — single container deployment - -Check out the [yattee-server](https://github.com/yattee/yattee-server) repository to get started. - -## Documentation - -- [Installation](https://github.com/yattee/yattee/wiki/Installation-Instructions) -- [Building](https://github.com/yattee/yattee/wiki/Building-instructions) -- [Features](https://github.com/yattee/yattee/wiki/Features) -- [FAQ](https://github.com/yattee/yattee/wiki/FAQ) -- [Screenshots Gallery](https://github.com/yattee/yattee/wiki/Screenshots-Gallery) -- [Tips](https://github.com/yattee/yattee/wiki/Tips) -- [Integrations](https://github.com/yattee/yattee/wiki/Integrations) -- [Donations](https://github.com/yattee/yattee/wiki/Donations) - -## Contributing - -Browse the [issues](https://github.com/yattee/yattee/issues) list or open a new one to discuss your idea. Every contribution is welcome. - -See [AGENTS.md](AGENTS.md) for developer setup and project architecture. - -Join [Discord](https://yattee.stream/discord) or the [Matrix channel](https://matrix.to/#/#yattee:matrix.org) if you need advice or want to discuss the project. - -## Translations - -Help make Yattee accessible to everyone by contributing translations. - - -Translation status - - -Localization hosting provided by [Weblate](https://weblate.org/en/). +* Native user interface built with [SwiftUI](https://developer.apple.com/swiftui/) with customization settings +* Player queue and history +* Player component with custom controls, gestures and support for 4K playback +* Fullscreen, Picture in Picture and background audio playback +* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip ## License - -Yattee is shared under the [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html) license. +Yattee and its components is shared on [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html) license.