Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme with badges and faq #96

Merged
merged 2 commits into from
Jun 25, 2020
Merged

Update readme with badges and faq #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c60332
Update readme with badges and faq
thornbill Jun 25, 2020
bcfac8e
Fix review suggestions
thornbill Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
<h1 align="center">Jellyfin Expo</h1>
<h3 align="center">Part of the <a href="https://jellyfin.media">Jellyfin Project</a></h3>
<h1 align="center">Jellyfin Mobile</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>

---

<p align="center">
Jellyfin Expo is a mobile app built with <a href="https://expo.io/">Expo</a> primarily targeting iOS devices.
<img alt="Logo banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/><br/>
<a href="https:/jellyfin/jellyfin-expo/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-expo"></a>
<a href="https:/jellyfin/jellyfin-expo/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-expo.svg"/></a>
<br/>
<a href="https://opencollective.com/jellyfin"><img alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/></a>
<a href="https://features.jellyfin.org"><img alt="Feature Requests" src="https://img.shields.io/badge/fider-vote%20on%20features-success.svg"/></a>
<a href="https://forum.jellyfin.org"><img alt="Discuss on our Forum" src="https://img.shields.io/discourse/https/forum.jellyfin.org/users.svg"/></a>
<a href="https://matrix.to/#/+jellyfin:matrix.org"><img alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
<a href="https://www.reddit.com/r/jellyfin"><img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/></a>
<br/><br/>
<a href="https://apps.apple.com/us/app/jellyfin-mobile/id1480192618?mt=8" style="display:inline-block;overflow:hidden;background:url(https://linkmaker.itunes.apple.com/en-us/badge-lrg.svg?releaseDate=2020-02-09&kind=iossoftware&bubble=ios_apps) no-repeat;width:135px;height:40px;"></a>
</p>

Jellyfin Mobile is a mobile app built with [Expo](https://expo.io/) primarily targeting iOS devices. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start. We use [GitHub Projects](https:/jellyfin/jellyfin-expo/projects) as a general roadmap for releases.

## Build Process

### Getting Started
Expand All @@ -23,3 +38,10 @@ Jellyfin Expo is a mobile app built with <a href="https://expo.io/">Expo</a> pri
yarn start
```
4. Follow the directions in the terminal or browser window to open on a device or emulator.

## FAQ

### What is the difference between this and other Jellyfin app projects?
* This app (Jellyfin Mobile) is a web wrapper based on Expo with some native enhancements. It is available on the [App Store](https://apps.apple.com/us/app/jellyfin-mobile/id1480192618?mt=8) for iPhone and iPad.
* [Jellyfin Player iOS](https:/jellyfin/jellyfin-client-ios) is a newer effort to create a media playback app in native Swift. It is a work in progress and currently only supports media playback.
* [Jellyfin React Client](https:/jellyfin-archive/jellyfin-react-client) an early project to create a single multiplatform app based on React Native. This project has been archived as we have changed direction to utilize native web wrappers on most platforms.