From 5d98fafe59a4b2795bc3507fa0ddf7f2511b9a9a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Juho=20Va=CC=88ha=CC=88-Herttua?= Date: Tue, 9 Apr 2013 12:51:59 +0300 Subject: [PATCH] Add supported flags to the README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 70fcde9..66ec140 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,23 @@ otherwise only the library is compiled and installed. Usage ----- -Check available options with ```shairplay --help``` and start server with -```shairplay```, if you are connected to a Wi-Fi the server should show as an -AirPort Express on your iOS devices and Mac OS X computers in the same network. +Check available options with ```shairplay --help```: + +``` +Usage: shairplay [OPTION...] + + -a, --apname=AirPort Sets Airport name + -p, --password=secret Sets password + -o, --server_port=5000 Sets port for RAOP service + --ao_driver=driver Sets the ao driver (optional) + --ao_devicename=devicename Sets the ao device name (optional) + --ao_deviceid=id Sets the ao device id (optional) + -h, --help This help +``` + +Start the server with ```shairplay```, if you are connected to a Wi-Fi the +server should show as an AirPort Express on your iOS devices and Mac OS X +computers in the same network. Related software ---------------- -- 2.34.1