diff --git a/README.md b/README.md index c7fc551e..2ef57c49 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@ Welcome to Streamyfin, a simple and user-friendly Jellyfin client built with Expo. If you're looking for an alternative to other Jellyfin clients, we hope you'll find Streamyfin to be a useful addition to your media streaming toolbox. -
- - - - - +
+ + + +
## 🌟 Features @@ -26,7 +25,7 @@ Streamyfin includes some exciting experimental features like media downloading a ### Downloading -Downloading works by using ffmpeg to convert a HLS stream into a video file on the device. This means that you can download and view any file you can stream! The file is converted by Jellyfin on the server in real time as it is downloaded. This means a **bit longer download times** but supports any file that your server can transcode. +Downloading works by using ffmpeg to convert an HLS stream into a video file on the device. This means that you can download and view any file you can stream! The file is converted by Jellyfin on the server in real time as it is downloaded. This means a **bit longer download times** but supports any file that your server can transcode. ### Chromecast @@ -34,19 +33,19 @@ Chromecast support is still in development, and we're working on improving it. C ## Plugins -In Streamyfin we have build in support for a few plugins. These plugins are not required to use Streamyfin, but they add some extra functionality. +In Streamyfin we have built-in support for a few plugins. These plugins are not required to use Streamyfin, but they add some extra functionality. ### Collection rows Jellyfin collections can be shown as rows or carousel on the home screen. -The following tags can be added to an collection to provide this functionality. +The following tags can be added to a collection to provide this functionality. -Avaiable tags: +Available tags: -- sf_promoted: Wil make the collection an row on home -- sf_carousel: Wil make the collection an carousel on home. +- sf_promoted: will make the collection a row at home +- sf_carousel: will make the collection a carousel on home. -A plugin exists to create collections based on external sources like mdblist. This makes managing collections like trending, most watched etc an automatic process. +A plugin exists to create collections based on external sources like mdblist. This make the automatic process of managing collections such as trending, most watched, etc. See [Collection Import Plugin](https://github.com/lostb1t/jellyfin-plugin-collection-import) for more info. ### Jellysearch @@ -90,7 +89,7 @@ We welcome any help to make Streamyfin better. If you'd like to contribute, plea ### Development info 1. Use node `20` -2. Install deps `bun i` +2. Install dependencies `bun i` 3. `Create an expo dev build by running `npx expo run:ios` or `npx expo run:android`. ## Extended chromecast controls diff --git a/assets/images/screenshots/androidscreen.png b/assets/images/screenshots/androidscreen.png new file mode 100644 index 00000000..3c7ad0dd Binary files /dev/null and b/assets/images/screenshots/androidscreen.png differ diff --git a/assets/images/screenshots/screenshot1.png b/assets/images/screenshots/screenshot1.png new file mode 100644 index 00000000..111573ca Binary files /dev/null and b/assets/images/screenshots/screenshot1.png differ diff --git a/assets/images/screenshots/screenshot2.png b/assets/images/screenshots/screenshot2.png new file mode 100644 index 00000000..183389f4 Binary files /dev/null and b/assets/images/screenshots/screenshot2.png differ diff --git a/assets/images/screenshots/screenshot3.png b/assets/images/screenshots/screenshot3.png new file mode 100644 index 00000000..af1d4d77 Binary files /dev/null and b/assets/images/screenshots/screenshot3.png differ diff --git a/assets/images/screenshots/screenshot4.png b/assets/images/screenshots/screenshot4.png new file mode 100644 index 00000000..d72a93fe Binary files /dev/null and b/assets/images/screenshots/screenshot4.png differ