Merge pull request #27 from neilenns/neilenns/issue24

Update readme with info

.markdownlint.jsonc

@@ -0,0 +1,4 @@
+{
+	// Disable line-length rule
+	"MD013": false
+}

DEVELOPMENT.md

@@ -0,0 +1,19 @@
+# Developing with this repo
+
+## Building
+
+1. Run `npm install`
+2. Run `npm run build`
+
+The first time you do this on any machine you also need to do `npm run link` otherwise the compiled plugin won't be available to the Stream Deck.
+
+For active development use `npm run watch` instead of `npm run build`, this will auto-refresh the plugin when files change.
+
+## Packaging
+
+Run `npm run package`. Make sure `npm run build` was done first.
+
+## Debugging
+
+VSCode can debug using the `Attach to Plugin` profile. Select the appropriate node.js instance. Yes, there should be a better, more automatic,
+way to do this. I'll figure it out someday.

README.md

@@ -1,19 +1,33 @@
-# TrackAudio buttons for Stream Deck
+# TrackAudio buttons for StreamDeck
 
-## Building
+This StreamDeck plugin provides buttons to display the current status of Tx, Rx, and Xc buttons in
+[TrackAudio](https://github.com/pierr3/TrackAudio).
 
-1. Run `npm install`
-2. Run `npm run build`
+After installation the plugin actions are available under the TrackAudio category:
 
-The first time you do this on any machine you also need to do `npm run link` otherwise the compiled plugin won't be available to the Stream Deck.
+![Screenshot of the StreamDeck profile UI with the categories filtered to "track"](docs/images/streamdeck-category.png)
 
-For active development use `npm run watch` instead of `npm run build`, this will auto-refresh the plugin when files change.
+## Configuring a station status button
 
-## Packaging
+The station status button displays the current status of a single station's button in TrackAudio, including
+whether communication is currently active.
 
-Run `npm run package`. Make sure `npm run build` was done first. 
+![Screenshot of the LMT_GND station position configured in TrackAudio for receive (Rx)](docs/images/trackAudio.png)
 
-## Debugging
+For example, to display status of the Rx button for LMT_GND, as shown in the image above, configure the
+station status button like this:
 
-VSCode can debug using the `Attach to Plugin` profile. Select the appropriate node.js instance. Yes, there should be a better, more automatic,
-way to do this. I'll figure it out someday.
+![Screenshot of a station status button configuration, with callsign set to LMT_GND, RX selected, and three custom images specified for the three states](docs/images/station-status.png)
+
+| Setting | Description |
+| - | - |
+| Callsign | The callsign for the station you want to display status for. Required. |
+| Listen to | What status to display on the button, either Rx, Tx, or XC. Required. |
+| Not listening | The image to display when the station is not currently active. Optional, defaults to black. |
+| Listening | The image to display when the station is active. Optional, defaults to green. |
+| Active comms | The image to display when a transmission is actively taking place. Optional, defaults to orange. |
+
+## Configuring a TrackAudio status button
+
+The TrackAudio status button shows the status of the connection between StreamDeck and TrackAudio. Simply
+add the button to your profile and, optionally, configure an image for the disconnected and connected states.