From 41eb1e9ca3b1653dadfcd4dfe146b525649898f4 Mon Sep 17 00:00:00 2001 From: Thomas Amland Date: Sat, 20 Mar 2021 14:31:25 +0100 Subject: [PATCH] update readme --- README.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 971d6e4..3949a56 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,38 @@ # Airsonic Web Client -[![](https://github.com/tamland/airsonic-frontend/workflows/CI/badge.svg)](https://github.com/tamland/airsonic-frontend/actions) +[![Build](https://img.shields.io/github/workflow/status/tamland/airsonic-frontend/CI?style=flat-square)](https://github.com/tamland/airsonic-frontend/actions) +[![Docker Pulls](https://img.shields.io/docker/pulls/tamland/airsonic-frontend?style=flat-square)](https://hub.docker.com/r/tamland/airsonic-frontend) -Modern responsive web frontend for [Airsonic](https://github.com/airsonic/airsonic). It's currently based on the [Subsonic API](http://www.subsonic.org/pages/api.jsp) and should work with other backends implementing this API as well. +Modern responsive web frontend for [Airsonic](https://github.com/airsonic-advanced/airsonic-advanced) and other [Subsonic](https://github.com/topics/subsonic) based music servers. + +## Features +- Responsive UI for desktop and mobile +- Browse library for albums, artist, generes +- Playback with persistent queue, repeat & shuffle +- MediaSession integration +- View, create, and edit playlists with drag and drop +- Built-in 'random' playlist +- Search +- Favourites +- Internet radio +- Podcasts + +## [Live demo](https://airsonic.netlify.com) + +Enter the following details: +Server: `/api` +Username: `guest4`, `guest5`, `guest6` etc. +Password:`guest` + +You can try the demo with your own local server as well. Simply enter the full URL of your Airsonic server in the Server field (such as http://localhost:8080) with your credentials. **Note**: if your server is using http only you must allow mixed content in your browser otherwise login will not work. + +## Screenshots ![Screenshot](screenshots/album.png) ![Screenshot](screenshots/albumlist.png) -## Supported features -- Responsive UI for desktop and mobile -- Playback with persistent queue, repeat, shuffle and MediaSession integration -- Browse library for albums, artist, generes -- View, create, and edit playlists with drag and drop support -- Play random songs with the built-in smart playlist -- Favourites -- Internet radio -- Search - -## Demo - -https://airsonic.netlify.com - -Server: `/api` -Username: `guest2`, `guest3`, `guest4` etc. -Password:`guest` - -You can use the URL and credentials for your own server if you prefer. **Note**: if your server is using http only you must allow mixed content in your browser otherwise login will not work. - - ## Install ### Docker