add README

diff --git a/CurrentCost.pl b/CurrentCost.pl
index 9037f9d..430ba05 100755 (executable)
--- a/CurrentCost.pl
+++ b/CurrentCost.pl
@@ -4,8 +4,9 @@
 #
 # This script may be considered to be a derivative of earlier work 
 # by Paul Mutton (http://www.jibble.org/currentcost/). I have 
-# merged the initialisation into one and added serial port locking
-# (via a separate perl module). See also CurrentCost-detect.pl.
+# merged the initialisation into the script and added serial port
+# locking (via a separate perl module). See also CurrentCost-detect.pl.
+# - wry
 #
 ######################################################################
 #

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..c687905
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+This repository contains the scripts I use to monitor my CurrentCost
+widget. Copy them to /usr/local/rrd/ (or someplace else and fix up the
+hard-coded paths), then read the instructions at the top of
+CurrentCost.pl and/or CurrentCost-detect.pl.
+
+The rrd graphing code isn't here; it's done by a very messy script that 
+isn't currently fit to publish. However http://www.jibble.org/currentcost/
+- which I drew on in creating these scripts - contains some useful
+pointers.