diff --git a/README.md b/README.md index 88fefbdc5..b551c1501 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,12 @@ The project's main goals are: * Be fully compatible with available [Subsonic clients](http://www.subsonic.org/pages/apps.jsp) (actively being tested with - [DSub](http://www.subsonic.org/pages/apps.jsp#dsub), - [SubFire](http://www.subsonic.org/pages/apps.jsp#subfire) and + [DSub](http://www.subsonic.org/pages/apps.jsp#dsub), + [SubFire](http://www.subsonic.org/pages/apps.jsp#subfire) and [Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash)) * Use all metadata from iTunes, so that you can keep using iTunes to manage your music -* Keep iTunes stats (play counts, last played dates, ratings, etc..) updated, at least on Mac OS X. - This allows smart playlists to be used in Subsonic Clients +* Keep iTunes stats (play counts, last played dates, ratings, etc..) updated, at least on Mac OS X. + This allows smart playlists to be used in Subsonic Clients * Help me learn Go ;) [![Gopher](https://blog.golang.org/favicon.ico)](https://golang.org) @@ -28,6 +28,16 @@ I'm currently trying to implement all functionality from API v1.8.0, with some e Check the (almost) up to date [compatibility chart](https://github.com/deluan/gosonic/wiki/Compatibility) for what is working. +### Installation + +As this is a work in progress, there are no installers yet. To have GoSonic running in your computer, follow the steps in the +Development Environment section below, then run it with: +``` +$ export GOSONIC_MUSICFOLDER="/path/to/your/iTunes Library.xml" +$ bee run +``` +The server should start and listening to port 4533. + ### Development Environment You will need to install [Go 1.6](https://golang.org/dl/) @@ -54,4 +64,4 @@ $ go test $(glide nv) -v GoSonic - Copyright (C) 2016 Deluan Cotts Quintao -The source code is licensed under GPL v3. License is available [here](/LICENSE) \ No newline at end of file +The source code is licensed under GPL v3. License is available [here](/LICENSE)