diff --git a/README.md b/README.md index 0bb8c33..cb861c1 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -An attempt at making a streaming audio app for the Jellyfin ecosystem \ No newline at end of file +# Jellyfin Audio Player +This is a React Native-based audio streaming app for Jellyfin. + +|![](./docs/images/now-playing.png)|![](./docs/images/recent-albums.png)|![](./docs/images/album-list.png)|![](./docs/images/search.png)| +|-|-|-|-| + +## Getting Started +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 +``` +npm run build:ios +``` +Then build the app in XCode \ No newline at end of file