From 602c1c03b56f66360767d5540e914e81981a463a Mon Sep 17 00:00:00 2001 From: Antoine Gersant Date: Mon, 14 Nov 2022 00:46:14 -0800 Subject: [PATCH] Added demo to readme --- README.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a4c773b..d2231f0 100644 --- a/README.md +++ b/README.md @@ -3,36 +3,49 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE-MIT) -Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device. Polaris works by streaming your music directly from your own computer, without uploading it to a third-party. It is free and open-source software, without any kind of premium version. The only requirement is that your computer stays on while it streams music! +Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device. Polaris works by streaming music directly from your computer (or cloud server), without uploading it to a third-party. It is free and open-source software, without any kind of premium version. + +## Try It Out! + +Check out the demo over at https://demo.polaris.stream, featuring a selection of Creative Commons Music. The credentials to access this server are: + +Username: `demo_user` +Password: `demo_password` ## Features + +![Polaris Web UI](res/readme/web_ui.png?raw=true "Polaris Web UI") + - Optimized for large music collections - Can run on Windows, Linux, BSD, or through Docker -- Listen to your music on the web or using the [Polaris Android](https://github.com/agersant/polaris-android) app -- Easy to setup and configure via the built-in web UI - Support for `flac`, `mp3`, `mp4`, `mpc`, `ogg`, `opus`, `ape`, `wav` and `aiff` files -- Support for album art images +- Easy to setup and administer, no configuration files needed +- Dark mode and customizable color themes +- Listen to your music on the go with [Polaris Android](https://github.com/agersant/polaris-android) - [Last.fm](https://www.last.fm) scrobbling -- Color themes -- Restrict access to your music collection with user accounts ## Tutorials - [Getting Started](docs/SETUP.md) - [Streaming From Remote Devices](docs/DDNS.md) -## Screenshots - -![Polaris Web UI](res/readme/web_ui.png?raw=true "Polaris Web UI") -![Polaris Web UI Dark Mode](res/readme/dark_mode.png?raw=true "Polaris Web UI") - ## Documentation - [Contribute to Polaris](docs/CONTRIBUTING.md) - [Maintenance Runbooks](docs/MAINTENANCE.md) ### API Documentation -The Polaris server API is documented via [Swagger](https://agersant.github.io/polaris/swagger). Please note that this Swagger page does not point to a live Polaris server so the `Try it out` buttons are not expected to work. -Every installation of Polaris also distributes this documentation, with the ability to use the `Try it out` buttons. To access it, simply open http://localhost:5050/swagger/ in your browser on the machine running Polaris. -Feel free to open Github issues or Pull Requests if clarifications are needed. +The Polaris server API is documented via [Swagger](https://demo.polaris.stream/swagger/). Every installation of Polaris distributes this documentation, with the ability to use the `Try it out` buttons. To access it, simply open http://localhost:5050/swagger/ in your browser on the machine running Polaris. + +## Credits & License Information + +Music featured in the demo installation: + +- [Chris Zabriskie - Abandon Babylon](https://chriszabriskie.bandcamp.com/album/abandon-babylon) [(License)](https://creativecommons.org/licenses/by/3.0/) +- [Chris Zabriskie - Angie's Sunday Service](https://chriszabriskie.bandcamp.com/album/angies-sunday-service) [(License)](https://creativecommons.org/licenses/by/3.0/) +- [glaciære - pool water blue](https://steviasphere.bandcamp.com/album/pool-water-blue) [(License)](https://creativecommons.org/licenses/by/3.0/) +- [glaciære - light ripples](https://steviasphere.bandcamp.com/album/light-ripples) [(License)](https://creativecommons.org/licenses/by/3.0/) +- [Koresma South](https://koresma.bandcamp.com/album/south) [(License)](https://creativecommons.org/licenses/by-nc-sa/3.0/) +- [Pete Murphy - Essence EP](https://petemurphy.bandcamp.com/album/falling-down-the-fred-astaires-solo-jazz-piano) [(License)](https://creativecommons.org/licenses/by-nc-sa/3.0/) +- [Rameses B - Essence EP](https://ramesesb.bandcamp.com/album/essence-ep) [(License)](https://creativecommons.org/licenses/by-nc-nd/3.0/)