Add README

This commit is contained in:
Arkadiusz Fal 2021-11-08 14:29:38 +01:00
parent e7e6bd109c
commit afcefc2e54
2 changed files with 54 additions and 0 deletions

52
README.md Normal file
View File

@ -0,0 +1,52 @@
# Yattee
Video player with support for [Invidious](https://github.com/iv-org/invidious) and [Piped](https://github.com/TeamPiped/Piped) instances built for iOS, macOS and tvOS.
## Features
* Native user interface built with [SwiftUI](https://developer.apple.com/xcode/swiftui/)
* Multiple instances and accounts, fast switching
* [SponsorBlock](https://sponsor.ajay.app/) with selection of categories to skip
* Player queue and history
* Fullscreen playback and Picture in Picture
* Stream quality selection
* Favorites: customizable section of channels, playlists, trending and other views
* AirPlay support
* Safari Extension for macOS and iOS for redirecting to the app
* URL Scheme for easy integrations
### Availability
| Feature | Invidious | Piped |
| ------- | --------- | ------|
| User Accounts | ✅ | 🔴 |
| Subscriptions | ✅ | 🔴 |
| Popular | ✅ | 🔴 |
| User Playlists | ✅ | 🔴 |
| Trending | ✅ | ✅ |
| Channels | ✅ | ✅ |
| Channel Playlists | ✅ | ✅ |
| Search | ✅ | ✅ |
| Search Suggestions | ✅ | ✅ |
## Installation
## Integrations
### Safari
Builtin extension
### Firefox
[Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)
### macOS
[Finicky](https://github.com/johnste/finicky)
## Tips
### Settings
* [tvOS] To open settings press Play/Pause button while hovering over navigation menu or video
### Navigation
* [iOS] Swipe the player/title bar: up to open fullscreen details view, bottom to close fullscreen details or hide player
### Favorites
* Add more sections by pressing button with heart on channels, playlists and other pages
* [iOS/macOS] Reorganize with dragging and dropping
* [iOS/macOS] Remove section with right click/press and hold on section name
* [tvOS] Reorganize and remove from `Settings > Edit Favorites...`
### Keyboard shortcuts
* `Command+P` - Play/Pause
* `Command+N` - Play next in the queue
* `Command+O` - Open player view

View File

@ -718,6 +718,7 @@
37D4B1AE26729DEB00C925CA /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
37D526DD2720AC4400ED2F5E /* VideosAPI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VideosAPI.swift; sourceTree = "<group>"; };
37D526E22720B4BE00ED2F5E /* View+SwipeGesture.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "View+SwipeGesture.swift"; sourceTree = "<group>"; };
37D9169A27388A81002B1BAA /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
37DD87C6271C9CFE0027CBF9 /* PlayerStreams.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PlayerStreams.swift; sourceTree = "<group>"; };
37E2EEAA270656EC00170416 /* PlayerControlsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PlayerControlsView.swift; sourceTree = "<group>"; };
37E64DD026D597EB00C71877 /* SubscriptionsModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SubscriptionsModel.swift; sourceTree = "<group>"; };
@ -1105,6 +1106,7 @@
37D4B174267164B000C925CA /* Tests Apple TV */,
37D4B0D72671614900C925CA /* Tests iOS */,
37D4B0E12671614900C925CA /* Tests macOS */,
37D9169A27388A81002B1BAA /* README.md */,
);
sourceTree = "<group>";
};