Revise README structure and content

Updated project description, added sections for introduction, screenshots, and future plans.
This commit is contained in:
Tenkuma 2026-01-21 19:40:41 -03:00 committed by GitHub
commit 910322277f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,8 +1,14 @@
## Gelli <img width="400" alt="CD disk with rainbow chroma on left followed by the strings 'Jamfish' on top and 'Delicious music client for Jellyfin' at the bottom." src="https://github.com/user-attachments/assets/993fae4a-f4e0-459d-b9ca-85ce548f1dea" />
This is a native music player for Android devices that connects to Jellyfin media servers. The code is based on a relatively recent version of Phonograph and was made for personal use, but contributions are welcome! Please open an issue to discuss larger changes before submitting a pull request. I am open to an improved icon if any graphic designers have a good suggestion. # Introduction
## Features This is a native music player for Android devices that connects to Jellyfin media servers. The code is based on Gelli's archived repository, which is based on an old version of Phonograph. Jamfish is made for personal use, but contributions are welcome! Please open an issue to discuss larger changes before submitting a pull request.
# Screenshots
<img width="4320" height="1560" alt="image(4)" src="https://github.com/user-attachments/assets/cba1fa13-9aae-44a6-94de-af5fdac8456f" />
# Features
* Basic library navigation * Basic library navigation
* Download songs to internal storage individually or through batch actions * Download songs to internal storage individually or through batch actions
@ -14,30 +20,23 @@ This is a native music player for Android devices that connects to Jellyfin medi
* Playback history reporting * Playback history reporting
* Filter content by library * Filter content by library
## Issues # Issues
Since this was a small project intended mainly for myself, there are some things I haven't resolved yet. I would appreciate pull requests to fix any of these issues! Since this was a small project intended mainly for myself, there are some things I haven't resolved yet. I would appreciate pull requests to fix any of these issues!
* Artist sorting isn't available through the API * Artist sorting isn't available through the API
* Playlists and favorites will not update automatically when changed * Playlists and favorites will not update automatically when changed
## Future Plans # Future Plans
If I ever find the time, these are some of the items I would potentially include. If I ever find the time, these are some of the items I would potentially include.
* Interface overhaul * Interface overhaul
* Offline downloads * Playing device songs
* SyncPlay * SyncPlay (Jellyfin built-in watchparty)
* Smart playlists * Smart playlists
* Session controls * Session controls
* QuickConnect * QuickConnect
* Support for videoclips
These are features I wouldn't include myself, but I would accept pull requests with good code.
* Support for other media types
* Chromecast * Chromecast
* Android Auto * Android Auto
## Screenshots
<img src='https://raw.githubusercontent.com/dkanada/gelli/master/metadata/en-US/screenshots.png'>