From 7ffb38b7f639917089620334c27d415f613ba65a Mon Sep 17 00:00:00 2001 From: Lei Nelissen Date: Tue, 7 Jul 2020 15:28:10 +0200 Subject: [PATCH] Update README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb861c1..cb1da42 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,21 @@ This is a React Native-based audio streaming app for Jellyfin. |-|-|-|-| ## Getting Started +What you want get started on depends on your intentions. As there is no build for general availability yet, you will need to build this project yourself. + +### Using the app +You will need to setup your Jellyfin account for the application to be able to pull in all your audio. To do this, go over to the "Settings" tab and click the "Set Jellyfin server"-button. A modal will pop up in which you will enter your Jellyfin server url, after which you enter your credentials in the provided browser view. When the app detects your credentials, they will automatically be remembered by the app. + +### Development Build This app has been mainly developed for iOS, but should mostly function on Android as well. To get started, do the following: 1. Clone this repository 2. Install [NodeJS](https://nodejs.org/en/) and [XCode](https://developer.apple.com/download/) 3. `npm install` 4. `npm run ios` -### Production +### Production Build +Follow step 1-3 from the development build, then do the following: ``` npm run build:ios ``` -Then build the app in XCode \ No newline at end of file +Then open `ios/JellyfinAudioPlayer.xcworkspace` and build the project in XCode. \ No newline at end of file