Add images to README

2020-07-07 15:19:10 +02:00
parent 105ecc1697
commit d409cd6f66
1 changed files with 18 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
-An attempt at making a streaming audio app for the Jellyfin ecosystem
+# 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