docs(readme): proofread and update readme

- scope of this repo has been redefined as only cmdlets related to WOL
- this file is inteded for implementation-specific contexts, not
relevant to the cmdlet itself

LICENSE

@@ -1,3 +1,5 @@
+The author of this software, as referred to herein, is Asif Bacchus <asif@asifbacchus.dev>. This software was written on September 3, 2021 and may have been updated since that date without necessarily updating the creation date noted herein.
+
 This is free and unencumbered software released into the public domain.
 
 Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

README.md

@@ -1,3 +1,108 @@
-# ps-cmdlet-wol
+# PowerShell cmdlet: Send Magic Packet
 
-PowerShell Wake-On-Lan cmdlet.
+PowerShell cmdlet (module/function) to send a *magic packet* based on provided MAC address(es). Comment-based help is
+included in the source-code: `Get-Help Send-MagicPacket -Full`
+
+## Installation and verification
+
+Downloads are available
+via [my git server (https://git.asifbacchus.dev/asif/ps-cmdlet-wol)](https://git.asifbacchus.dev/asif/ps-cmdlet-wol)
+and [GitHub (https://github.com/asifbacchus/ps-cmdlet-wol)](https://github.com/asifbacchus/ps-cmdlet-wol). You may
+verify the cmdlet's integrity using [CodeNotary](https://codenotary.io) via `vcn authenticate` or by dropping the
+downloaded script onto their verification webpage at [https://verify.codenotary.io](https://verify.codenotary.io).
+Please always try to verify downloaded scripts and software regardless of the source!
+
+## Overview
+
+The function sends two (2) magic packets spaced one (1) second apart. One set of magic packets will be sent per MAC
+address submitted either directly via the `MacAddress` parameter or via the pipeline (implicitly or explicitly). Usage
+examples are provided via `Get-Help Send-MagicPacket -Examples`.
+
+The only mandatory parameter is `MacAddress` which can be provided directly or via the pipeline either implicitly or
+explicitly (parameter is in the first position). `MacAddress` is an *array of strings*. The actual hex values of the MAC
+address can be separated with a colon (':') and/or a hyphen ('-'). For example, the following MAC addresses are all
+valid even within the same command:
+
+```powershell
+Send-MagicPacket '1a:2b:3c:4d:5e:aa', 'a1-b2-c3-d4-e5-bb', '1a:2b-3c:4d-5e-cc'
+```
+
+By default, the magic packet will be sent on the global broadcast address for your current system (e.g. 255.255.255.255)
+using UDP on the *echo* port (7). These options can be customized via parameters:
+
+- `-BroadcastIP` | `IP` | `Address`: Broadcast address to use. By default, this is 255.255.255.255 but you really should
+  use a subnet specific broadcast address instead (e.g. 192.168.1.255). See
+  the [Broadcast considerations](#broadcast-considerations) section for more discussion.
+- `Port`: Allows changing the UDP port over which the magic packet is sent. This is by default port 7 (echo). Port 9 (
+  discard) is also quite common but any port can be used depending on your particular environment.
+
+The magic packet is constructed as per standards: 6 byte header consisting of '255' (hex:FF) followed by the
+hex-represented MAC addresses repeated 16 times.
+
+## Broadcast considerations
+
+Long ago in a galaxy far away... actually a few decades ago right here on Earth, the easiest way to send Wake-On-Lan (
+WOL) packets was simply to use the global IP4 all-subnets broadcast address of 255.255.255.255. Because this generates a
+lot of un-needed traffic, breaks subnet isolation and can be an attack vector, many routers and switches now block this
+type of broadcast. Although this remains the default for most WOL applications (including this function), it is vastly
+more reliable and preferred to use a subnet-specific broadcast address. For example, if you are concerned with computers
+on your subnet of 192.168.1.0/24 then you would use the broadcast address of 192.168.1.255.
+
+More recently, it has also become somewhat common to use the multicast all-hosts address of **224.0.0.1** when sending
+WOL packets. If broadcast is not working in your environment, you may want to try this as a possible workaround.
+
+Things become a little more complicated with IP6. There is no concept of 'broadcast' in IP6 and thus, you need to use
+multicast. I have not extensively tested IP6 WOL since I tend to continue using IP4 for this purpose (all my networks
+are dual-stack). I would assume the simplest place to start testing would be using the link-local all-nodes address
+of **ff02::1**. I suspect this should work across most networks, but I have not tested it extensively and it would
+depend greatly on switches, routers and even machine specific set-ups.
+
+## Pipeline
+
+This function is geared toward pipeline usage. The variable `MacAddress` is parameterized and used by the function for
+an array of string objects representing individual MAC addresses. This is consistent with WMIC/CIMv2 output for most NIC
+queries and allows this function to be easily called using piped output from such a query. To see this, try sending some
+dummy magic packets to the localhost for all interfaces on the local machine:
+
+```powershell
+# get name, manufacturer and MAC address for connected interfaces and pipe to our function 
+Get-CimInstance -Query "Select * From Win32_NetworkAdapter Where NetConnectionStatus=2" | Select-Object Name, Manufacturer, MacAddress | Send-MagicPacket -IP 127.0.0.1 -Verbose
+```
+
+You will notice I've selected stuff we don't need (Name, Manufacturer) to show that the function can parse and pick up
+named the `MacAddress` of each object (network interface) and then send a magic packet to 127.0.0.1 on port 7 (echo).
+This is not at all useful, but demonstrates pipeline usage quite nicely, I think. A simpler demonstration would be the
+following:
+
+```powershell
+# send magic packets to two machines over IP4 localhost using port 9 (discard)
+'1a:2b:3c:4d:5e:aa', 'a1:b2:c3:d4:e5:bb' | Send-MagicPacket -BroadcastIP 127.0.0.1 -Port 9
+```
+
+## Module or Function
+
+This was intended to be used as a simple function that can be integrated into other scripts directly or, more
+conveniently, loaded as a module and referenced as needed in a variety of use-cases.
+
+If using as a function, simply place it within your script. If you want to load it as a module either `Load-Module`
+within your script or do so at a PS prompt:
+
+```powershell
+# load module
+Load-Module C:\path\to\module\wol-magicPacket.psm1
+
+# call module anytime after loading within the same session
+Send-MagicPacket ...
+```
+
+## Feedback
+
+I coded this pretty quickly for a project I was working on in a small LAN deployment. I also use it routinely in
+networks of various sizes and over VPN connections and also when I'm too lazy to move from my office to the living room
+to turn on my media centre. I've polished it up and added comment-based help for the version in this repo, hence the
+more recent creation date. I'm always interested in improvements since I don't code in PowerShell that often and I'm
+sure this can be vastly improved. Please send any suggestions, bugs, etc. to me by filing an issue.
+
+I hope you find this useful! As indicated by the license, you can use this code for whatever you want in any capacity.
+If you do use it, a link to my blog at [https://mytechiethoughts.com](https://mytechiethoughts.com) would be greatly
+appreciated!

computerList.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<db>
-    <Configuration>
-        <AlwaysAuthorized>
-            "ITStaff",
-            "Administrators",
-            "Domain Admins"
-        </AlwaysAuthorized>
-    </Configuration>
-    <Computers>
-        <Computer name="Computer001" mac="AA:1A:2A:3A:4A:01" authorized="any"/>
-        <Computer name="Computer002" mac="BB:1B:2B:3B:4B:02" authorized="Managers"/>
-        <Computer name="Computer003" mac="CC:1C:2C:3C:4C:03" authorized="User3"/>
-    </Computers>
-</db>

wol-magicPacket.psm1

@@ -11,7 +11,7 @@ Note: You must specify the '-Verbose' parameter to see output for successfully s
 Array of MAC addresses for which to construct magic packets. The array should be provided in standard comma-separated string format ('1a:2a:3a:4a:5a:aa', '1b:2b:3b:4b:5b:bb', ...). You may use either a colon (:) or a hyphen (-) to delimit each hex value-pair in the MAC address. You may supply this array either directly or via the pipline.
 
 .PARAMETER BroadcastIP
-The address to which magic packets should be sent in order for them to be broadcast across the subnet. By default this is 255.255.255.255 however, many routers block such global broadcasts. Therefore, it is suggested to use the subnet-specific broadcast address (e.g. 192.168.1.255). You may also use IP6 addresses if you prefer.
+The address to which magic packets should be sent in order for them to be broadcast across the subnet. By default this is 255.255.255.255 however, many routers block such global broadcasts. Therefore, it is suggested to use the subnet-specific broadcast address (e.g. 192.168.1.255). You may also use IP6 multicast addresses (ff02::1 may work in your environment) if you prefer.
 
 .PARAMETER Port
 The UDP port that should be used when sending the broadcast. By default this is port 7 (echo). Port 9 (discard) is also a common port.