X-Git-Url: http://git.rot13.org/?p=Biblio-RFID.git;a=blobdiff_plain;f=README;h=23bf9b79c4ece7332edface22d3cf38585436dca;hp=ac9bcc212918265394699203e04756ddd681e4dc;hb=660dd42983d00fbc94c01b0efe2276d55c2fb2d4;hpb=7570c8afc774f62f91769251e9ed7575ca92f720

diff --git a/README b/README
index ac9bcc2..23bf9b7 100644
--- a/README
+++ b/README
@@ -1,73 +1,92 @@
-RFID-Biblio
+NAME
+    RFID::Biblio - perl tools to use different RFID readers for library use
 
-This is set of tools to use different RFID readers for library use.
+DESCRIPTION
+    Main idea is to develop simple API to reader, and than provide useful
+    abstractions on top of it to quickly write applications to respond on
+    tags which come in range of RFID reader using RFID::Biblio::Reader.
 
-Main idea is to develop simple API to reader, and than provide useful
-abstractions on top of it to quickly write applications to respond on
-tags which come in range of RFID reader.
+    Writing support for new RFID readers should be easy.
+    RFID::Biblio::Reader::API provides documentation on writing support for
+    different readers.
 
-scripts/RFID-JSONP-server.pl is example of such application. It's local
-interface to RFID reader and JSONP REST server.
+    Currently, two serial RFID readers based on RFID::Biblio::Reader::Serial
+    are implemented:
 
-examples/koha-rfid.js is jQuery based JavaScript code which can be inserted
-in Koha Library System to provide overlay with tags in range and check-in/check-out
-form-fill functionality.
+    *   RFID::Biblio::Reader::3M810
 
-Currently supported readers:
+    *   RFID::Biblio::Reader::CPRM02
 
- * 3M 810  - RFID::Biblio::3M810
- * CPR-M02 - RFID::Biblio::CPRM02
- * OpenPCD, The Omnikey CardMan 5121 and 5321 - RFID::Biblio::librfid
+    There is also simple read-only reader using shell commands in
+    RFID::Biblio::Reader::librfid.
 
-For status of each implementation see pod documentation inside them.
+    For implementing application take a look at RFID::Biblio::Reader
 
+    `scripts/RFID-JSONP-server.pl' is example of such application. It's
+    local interface to RFID reader and JSONP REST server.
 
-INSTALLATION
+    `examples/koha-rfid.js' is jQuery based JavaScript code which can be
+    inserted in Koha Library System to provide overlay with tags in range
+    and check-in/check-out form-fill functionality.
 
-To install this module, run the following commands:
+HARDWARE SUPPORT
+  3M 810
+    RFID::Biblio::Reader::3M810
 
-	perl Makefile.PL
-	make
-	make test
-	make install
+  CPR-M02
+    RFID::Biblio::Reader::CPRM02
 
-SUPPORT AND DOCUMENTATION
+  librfid
+    RFID::Biblio::Reader::librfid
 
-After installing, you can find documentation for this module with the
-perldoc command.
+AUTHOR
+    Dobrica Pavlinusic, `<dpavlin at rot13.org>'
 
-    perldoc RFID::Biblio
+    http://blog.rot13.org/
 
-You can also look for information at:
+BUGS
+    Please report any bugs or feature requests to `bug-rfid-biblio at
+    rt.cpan.org', or through the web interface at
+    http://rt.cpan.org/NoAuth/ReportBug.html?Queue=RFID-Biblio. I will be
+    notified, and then you'll automatically be notified of progress on your
+    bug as I make changes.
 
-    RT, CPAN's request tracker
+SUPPORT
+    You can find documentation for this module with the perldoc command.
+
+        perldoc RFID::Biblio
+        perldoc RFID::Biblio::Reader
+        perldoc RFID::Biblio::Reader::API
+
+    You can also look for information at:
+
+    * RT: CPAN's request tracker
         http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Biblio
 
-    AnnoCPAN, Annotated CPAN documentation
+    * AnnoCPAN: Annotated CPAN documentation
         http://annocpan.org/dist/RFID-Biblio
 
-    CPAN Ratings
+    * CPAN Ratings
         http://cpanratings.perl.org/d/RFID-Biblio
 
-    Search CPAN
+    * Search CPAN
         http://search.cpan.org/dist/RFID-Biblio/
 
-
+ACKNOWLEDGEMENTS
 LICENSE AND COPYRIGHT
+    Copyright 2010 Dobrica Pavlinusic.
 
-Copyright (C) 2010 Dobrica Pavlinusic
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; version 2 dated June, 1991 or at your option
-any later version.
+    This program is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; version 2 dated June, 1991 or at your option
+    any later version.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+    Public License for more details.
 
-A copy of the GNU General Public License is available in the source tree;
-if not, write to the Free Software Foundation, Inc.,
-59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+    A copy of the GNU General Public License is available in the source
+    tree; if not, write to the Free Software Foundation, Inc., 59 Temple
+    Place - Suite 330, Boston, MA 02111-1307, USA.