From a37b6958abc2bb29d9209c40e0f2e7166735354c Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Mon, 8 Dec 2014 12:26:39 +0000 Subject: [PATCH] Fix README. --- README | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/README b/README index 10b3f3e..f449964 100644 --- a/README +++ b/README @@ -1,16 +1,10 @@ -IndexData-Utils version 0.01 -============================ +IndexData-Utils +=============== -The README is used to introduce the module and provide instructions on -how to install the module, any machine dependencies it may have (for -example C compilers and installed libraries) and any other information -that should be provided before the module is installed. +This library contains utility functions that we at Index Data want to +share between multiple applications -- for example, the persistent +counter used by both IRSpy (see issue IR-350) and MKHome (IR-351). -A README file is required for CPAN modules since CPAN extracts the -README file from a module distribution so that people browsing the -archive can use it get an idea of the modules uses. It is usually a -good idea to provide version information here so that people can -decide whether fixes for the module are worth downloading. INSTALLATION @@ -21,20 +15,12 @@ To install this module type the following: make test make install -DEPENDENCIES - -This module requires these other modules and libraries: - - blah blah blah - COPYRIGHT AND LICENCE -Put the correct copyright and licence information here. - -Copyright (C) 2014 by Mike Taylor +Copyright (C) 2014 by Index Data. This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself, either Perl version 5.18.2 or, +it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available. -- 1.7.10.4