From f3dbfc44f4fd3e1989b150331a29df05659dde74 Mon Sep 17 00:00:00 2001
From: bilbo-b <38690792+bilbo-b@users.noreply.github.com>
Date: Tue, 2 Feb 2021 22:37:02 +0100
Subject: [PATCH] Create README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ca4defa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# rock
+a shell script to remote control some aspects of a roonlabs ROCK installation
+
+rock <cmd>
+		possible <cmd> are:
+		    poweroff:  shuts down gracefully and powers off at $ROCKIP
+		    wake:      sends "magic packet" to ROCK over network to power on
+		    status:    gives back some JSON-formatted status output of ROCK at $ROCKIP
+		    has_cdrom: outputs "no_cd_rom" if none connected or other
+		    eject:     ejects disk in a connected CDROM (if one is connected)
+		    reboot:    reboots your ROCK
+		    restart:   restarts ROON software
+		    stop:      stops ROON software 
+		    wake:      sends "magic packet" to ROCK over network to power on
+		    requirements:
+		    poweroff, status, has_cdrom, eject, reboot, restart, stop need "curl"
+		    wake needs "etherwake" and the proper mac-address in /etc/ethers for "rock"
+		    status, has_cdrom and eject need "jq" installed