readme HEAD main

1 files changed, 27 insertions, 1 deletions

diff --git a/README.md b/README.md
index 857f90b..3ce8dc1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 **wolff**
 
-send Wake-on-LAN packets.
+send [Wake-on-LAN](#wol-wake-on-lan) packets.
+
+wolff sends WoL packets using the UDP protocol with a configurable port number,
+but defaults to a port of 9 which is a defacto standard.
+
+### Arguments
+**`mac=<addr>`**  
+specify the MAC address of the system you want to wake up
+
+**`host=<ip>`**  
+IP address to send the magic bytes to via UDP. Defaults to `255.255.255.255`
+which is the "this network" broadcast address.
+
+**`port=<port>`**  
+port number the UDP packet is sent to. Defaults to port 9, which is a defacto
+standard when sending WoL magic packets.
+
+[broadcast-wikipedia]: https://en.wikipedia.org/wiki/Broadcast_address#IP_networking
+
+### WoL *(Wake-on-Lan)*
+referencing its wikipedia article: [wikipedia.org/Wake-on-Lan](https://en.wikipedia.org/wiki/Wake-on-LAN#Magic_packet)
+
+The Magic Packet needs only to contain specific bytes within it's payload.
+It does not need to be any specific protocol or use any specific port. As long
+as WoL is enabled, so the NIC keeps power when the computer is asleep, it will
+be looking for a run of six `FF` bytes followed by the MAC Address of the system
+you want to wake, repeated sixteen times.