initial commit

1 files changed, 4 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9053377
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+This is the program which I use to display the "Now playing: ..." text on my radio page using `libwebsocketclient`. It uses `libmpdclient` to enter an idle state awaiting reported changes from the player. This way the program goes dormant until mpd informs it that the song has changed, then it will poll the current song info and send an update to each connected client.
+
+The config variables are stored in `mpd_ws.h`.
+The Makefile is intended to build the binary using OpenBSD make(1) but it should work on every system.