From 16e255ba87acc54c41d522b7c45d6a25c021d55e Mon Sep 17 00:00:00 2001
From: "Paul C. Buetow (mars.fritz.box)" <paul@buetow.org>
Date: Sun, 22 Jun 2014 11:30:05 +0200
Subject: New release

---
 .version          |  2 +-
 Makefile          |  2 ++
 README.pod        | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 debian/changelog  |  6 +++++
 debian/files      |  2 +-
 docs/guprecords.1 |  2 +-
 6 files changed, 85 insertions(+), 3 deletions(-)
 create mode 100644 README.pod

diff --git a/.version b/.version
index 0c62199..ee1372d 100644
--- a/.version
+++ b/.version
@@ -1 +1 @@
-0.2.1
+0.2.2
diff --git a/Makefile b/Makefile
index 57b8e75..f8214d8 100644
--- a/Makefile
+++ b/Makefile
@@ -34,6 +34,8 @@ documentation:
 	pod2man --release="$(NAME) $$(cat .version)" \
 		--center="User Commands" ./docs/$(NAME).pod > ./docs/$(NAME).1
 	pod2text ./docs/$(NAME).pod > ./docs/$(NAME).txt
+	# For Github
+	cp ./docs/${NAME}.pod README.pod
 
 # Build a debian package (don't sign it, modify the arguments if you want to sign it)
 deb: all
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..d060e11
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,74 @@
+=head1 NAME
+
+guprecords - Global uptime records
+
+Shows uprecord stats of several hosts at once.
+
+=head2 Synopsis
+
+guprecords [--help] [--total|--all] [--count=i] [--indir=s]
+
+=head2 Parameters
+
+=over
+
+=item --all
+
+Shows every individual uptime of all hosts.
+
+=item --count=i
+
+Show i num of entries. Default is 23.
+
+=item --nofqdn
+
+Don't display the FQDNs
+
+=item --help
+
+Shows the help
+
+=item --indir=s
+
+Read all the *.records files from dir s. Default is ./
+
+=item --total
+
+Aggregates a total uptime for every single host.
+
+=back
+
+
+=head2 Quick getting started
+
+=head3 Uptimed
+
+Firstival, you need to collect uprecords using the uptimed deaemon. To install it run:
+
+    sudo aptitude install uptimed
+
+Please consult the L<uptimed> and L<uprecords> manpages. Please ensure to understand how it works and what it does.
+
+uptimed collects uprecords to 
+
+  /var/spool/uptimed/records
+
+And this file is used by guprecords for further processing.
+
+=head3 Collect all the uprecords
+
+You may have several hosts with uptimed running already. Collect all the records file to a central repository (e.g. git).  Name each file FQDN.records and run
+
+  guprecords --indir ./
+
+You may automate the collecting of all the uprecords using something like cron or puppet.
+
+=head1 LICENSE
+
+See package description or project website.
+
+=head1 AUTHOR
+
+Paul Buetow - <http://guprecords.buetow.org>
+
+=cut
diff --git a/debian/changelog b/debian/changelog
index a765cfa..566d018 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+guprecords (0.2.2) stable; urgency=low
+
+  * Add README.pod for github page
+
+ -- Paul Buetow <paul@buetow.org>  Sun, 22 Jun 2014 11:29:44 +0200
+
 guprecords (0.2.1) stable; urgency=low
 
   * Remove make dput from release Makefile target
diff --git a/debian/files b/debian/files
index f8f83cb..e323e14 100644
--- a/debian/files
+++ b/debian/files
@@ -1 +1 @@
-guprecords_0.2.1_all.deb utils optional
+guprecords_0.2.2_all.deb utils optional
diff --git a/docs/guprecords.1 b/docs/guprecords.1
index 10bd93c..c205e13 100644
--- a/docs/guprecords.1
+++ b/docs/guprecords.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "GUPRECORDS 1"
-.TH GUPRECORDS 1 "2014-06-20" "guprecords 0.2.1" "User Commands"
+.TH GUPRECORDS 1 "2014-06-20" "guprecords 0.2.2" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
-- 
cgit v1.2.3