Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
mnvr committed Nov 10, 2018
1 parent c7cb84a commit a846a29
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 11 deletions.
Binary file added Artwork/main-window.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Artwork/status-bar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@
# Soundtrack ⌬

Soundtrack is a minimalistic internet radio player for macOS and
iOS. It allows you to tune into one radio station. Subsequently you
can quickly play/pause that station by clicking the status bar
icon. You get notifications for song changes.
Soundtrack is a minimal music player for macOS. You give it a URL of
an internet radio station, which it’ll remember. There is a play
button, and the name of the currently playing song which you can click
to pause.

To set the radio station, paste the URL of the radio station in the
Soundtrack window. This is the HTTP link to the shoutcast playlist
file, ending in ".pls" or ".m3u".
![Main Window](Artwork/main-window.gif)

## Advanced
Like iTunes, it will tell you the name of the new song when the song
changes. And there is a status bar icon to quickly play and pause
without having to open the app.

![Status Bar Icon](Artwork/status-bar.gif)

It also works on iPhones.

To set the radio station, paste the URL of the radio station in the
Soundtrack window. This URL is the HTTP link to the shoutcast playlist
file, usually ending in ".pls" or ".m3u" (something like
"http://example.org/station.pls").

* If you choose to hide the dock icon, you can show the Soundtrack
window by right or control clicking the status bar icon.
[Download](https://github.com/mnvr/Soundtrack/releases/download/v1.0/Soundtrack.zip)

## Obtaining Soundtrack
## Advanced

### Building from Source

There are no external dependencies. Download the source code, then
build and run in Xcode.

### Hiding the Dock Icon

If you choose to hide the dock icon, you can show the Soundtrack
window by right or control clicking the status bar icon.

0 comments on commit a846a29

Please sign in to comment.