]> git.ipfire.org Git - thirdparty/shairport-sync.git/commitdiff
Version 3.0!
authorMike Brady <mikebrady@eircom.net>
Tue, 27 Sep 2016 16:03:49 +0000 (17:03 +0100)
committerGitHub <noreply@github.com>
Tue, 27 Sep 2016 16:03:49 +0000 (17:03 +0100)
README.md

index bf05aa88fadab2bb53a187e50206e285f5530cbb..bcfec00179a4464a7c809d935e804f78e83b7013 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,15 @@
 Shairport Sync
 =============
+**Welcome to Version 3 of Shairport Sync. This is a big update from version 2.X and is still a work in progress. Please see the Releas Notes for some more information**
+
 Shairport Sync is an AirPlay audio player — it plays audio streamed from iTunes, iOS devices and other AirPlay sources such as Quicktime Player and ForkedDaapd, among others.
 Audio played by a Shairport Sync-powered device stays synchronised with the source and hence with similar devices playing the same source. In this way, synchronised multi-room audio is possible without difficulty. (Hence the name Shairport Sync, BTW.)
 
 Shairport Sync does not support AirPlay video or photo streaming.
 
-**Please note that, between 2.8.4.6 and 2.8.4.7, there is a change in the standard ./configure arguments which you should not ignore!** 
-
 This is the unstable "development" branch. Changes and updates are incorporated into this branch quickly. To access the stable version, where changes are made after due time, please switch to the "master" branch.
 
+
 More Information
 ----------
 Shairport Sync works by using timing information and timestamps present in data coming from the audio source (e.g. an iPhone) to play audio at exactly the right time. It does this by monitoring and controlling the *latency* — the time-gap between when a sound frame is supposed to be played, as specified by its `timestamp`, and the time when it is actually played by the audio output device, usually a Digital to Audio Converter (DAC).