read stdin instead of polling a text file

[now-playing-d.git] / README

diff --git a/README b/README
index 084fda0..6ea8e36 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,45 @@
-This is a very simple program which displays one line of text in the
-notification area.
+now-playing-d
 
-It reads a file (~/tmp/now-playing) every second, and displays the contents in
-the notification area. For best results, make sure there's no newlines in the
-file, and that there's not too much text.
+NAME
+       now-playing-d - display text from stdin in the notification area.
 
-You can build it with this command: make
+DESCRIPTION
 
-And install it in your ~/bin with this command: make install
+       now-playind-d reads from stdin. Whenever a full new line is read, this
+       text is displayed in the notification area (replacing any text
+       now-playing-d put there before, if any).
+       
+       Careful not to make the lines too long for your notification area.
 
-This program is licensed under the GNU GPLv3+.
+BUILDING
 
-This download also contains a copy of eggtrayicon by Anders Carlsson, which is
-licensed under the GNU LGPLv2+
+       make
+
+
+INSTALLING
+
+       To install to ~/bin:
+
+       make install
+
+       or just copy now-playing-d wherever you like
+
+
+USAGE
+
+       Here's an example of how to make it so you can "echo" text to it from scripts:
+
+       mkfifo ~/tmp/now-playing
+       while true; do cat ~/tmp/now-playing; done | now-playing-d
+
+       echo 'Hello, world!' > ~/tmp/now-playing
+       sleep 2
+       echo 'another message' > ~/tmp/now-playing
+
+
+LICENSING
+
+       This program is licensed under the GNU GPLv3+.
+
+       This download also contains a copy of eggtrayicon by Anders Carlsson,
+       which is licensed under the GNU LGPLv2+