added README

1 files changed, 20 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2ae7a60
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+Guardian is a terminal command that can be run to display an encouraging
+messages on all pseudottys (basically any terminal emulator) on a machine. In
+addition it controls a electronic "buddy" that blocks the keyboard to remind the
+user to take a break from the computer once in a while.
+
+Example Usage:
+	guardian kitty "You can do it!" /dev/ttyUSB0
+	guardian trees "You should take a walk" /dev/ttyS0
+To raise the "buddy"'s arm again use:
+	guardian raise /dev/ttyUSB0
+
+Acknoledgements:
+
+The RS-232 library(https://www.teuniz.net/RS-232/) Teunis Van Beelen was used
+under GPLv3 to communicate with the Arduino used to drive the "buddy".
+
+LICENSE:
+
+This software is free software and provided under the Gnu General Public License
+version 3.