Browse Source

Added README.

housekeeping/remove-warnings
Antoine POPINEAU 5 years ago
parent
commit
bf1bba1162
No known key found for this signature in database
GPG Key ID: A78AC64694F84063
  1. 35
      README.md

35
README.md

@ -0,0 +1,35 @@ @@ -0,0 +1,35 @@
# Otter for Funkwhale
![](https://img.shields.io/github/license/apognu/otter?style=flat-square)
[![](https://img.shields.io/travis/apognu/otter/master?style=flat-square)](https://travis-ci/apognu/otter)
[![](https://img.shields.io/badge/Play%20Store-otter-informational?style=flat-square)](https://play.google.com/store/apps/details?id=com.github.apognu.otter)
[![](https://img.shields.io/badge/APK-otter-informational?style=flat-square)](https://github.com/apognu/otter/releases)
Otter is a native Android music player for [Funkwhale](https://funkwhale.audio), native to Android (developed in Kotlin) and to Funkwhale (uses its native API instead of Subsonic).
![Otter graphic](https://github.com/apognu/otter/raw/master/app/src/main/play/listings/en-US/graphics/feature-graphic/1.png)
## State
A beta version of the app can be downloaded on [Google Play](https://play.google.com/store/apps/details?id=com.github.apognu.otter) or through [GitHub releases](https://github.com/apognu/otter/releases). Please bear with it, there **will** be bugs, there **will** be crashes and there **will** be performance or UX issues.
Otter's features, as of this writing, are the following:
* Basic collection browsing (artists, albums and tracks)
* Playlists listing
* Favorites management (listing and add/remove)
* Track search
* Queue management
* Caching of played tracks (played tracks work offline)
* Dark mode! 🎉
Otter will try to behave as you would expect a mobile music player to, meaning integrating with the OS's media controls (including headset controls) or pause on incoming calls. If there is anything you would like it to do, please [open an issue](https://github.com/apognu/otter/issues/new).
## Roadmap
Here is a (non-binding, unfinished) list of what we would like Otter to be able to do - _eventually_:
* F-Droid listing
* Playlist management (including creation and adding/removing of tracks)
* Chromecast support
* Download ("pin in cache") tracks
Loading…
Cancel
Save