docs: update README

This commit is contained in:
Deluan
2020-02-05 08:40:15 -05:00
parent 19fb29e520
commit 5fbde33b97
+7 -4
View File
@@ -6,9 +6,7 @@
[![Join the Chat](https://img.shields.io/discord/671335427726114836?style=for-the-badge)](https://discord.gg/xh7j7yF) [![Join the Chat](https://img.shields.io/discord/671335427726114836?style=for-the-badge)](https://discord.gg/xh7j7yF)
Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your
music collection from any browser or mobile device. music collection from any browser or mobile device. It's like your personal Spotify!
This is a fully functional _alpha quality_ software. Expect some changes in the feature set and the way it works.
__Any feedback is welcome!__ If you need/want a new feature, find a bug or think of any way to improve Navidrome, __Any feedback is welcome!__ If you need/want a new feature, find a bug or think of any way to improve Navidrome,
please fill a [GitHub issue](https://github.com/deluan/navidrome/issues) or join the chat in our [Discord server](https://discord.gg/xh7j7yF) please fill a [GitHub issue](https://github.com/deluan/navidrome/issues) or join the chat in our [Discord server](https://discord.gg/xh7j7yF)
@@ -29,19 +27,22 @@ please fill a [GitHub issue](https://github.com/deluan/navidrome/issues) or join
See the [complete list of available mobile and web apps](https://airsonic.github.io/docs/apps/) See the [complete list of available mobile and web apps](https://airsonic.github.io/docs/apps/)
- Transcoding/Downsampling on-the-fly (WIP. Experimental support is available) - Transcoding/Downsampling on-the-fly (WIP. Experimental support is available)
## Road map ## Road map
This project is being actively worked on. Expect a more polished experience and new features/releases This project is being actively worked on. Expect a more polished experience and new features/releases
on a frequent basis. Some upcoming features planned: on a frequent basis. Some upcoming features planned:
- Last.FM integration
- Integrated music player - Integrated music player
- Last.FM integration
- Pre-build binaries for Raspberry Pi - Pre-build binaries for Raspberry Pi
- Smart/dynamic playlists (similar to iTunes) - Smart/dynamic playlists (similar to iTunes)
- Support for audiobooks (bookmarking)
- Jukebox mode - Jukebox mode
- Sharing links to albums/songs/playlists - Sharing links to albums/songs/playlists
- Podcasts - Podcasts
## Installation ## Installation
Various options are available: Various options are available:
@@ -82,6 +83,8 @@ services:
- "/Users/deluan/Music/iTunes/iTunes Media/Music:/music" - "/Users/deluan/Music/iTunes/iTunes Media/Music:/music"
``` ```
To get the cutting-edge, latest version from master, use the image `deluan/navidrome:develop`
### Build from source ### Build from source
You will need to install [Go 1.13](https://golang.org/dl/) and [Node 13.7.0](http://nodejs.org). You will need to install [Go 1.13](https://golang.org/dl/) and [Node 13.7.0](http://nodejs.org).