X-Git-Url: http://git.rot13.org/?p=Biblio-RFID.git;a=blobdiff_plain;f=README;h=9610b1c7b8d281e87342a5c6d36179eb73115559;hp=ba6c49c6164e542418d79b19bdc645708340c190;hb=refs%2Fheads%2Frfid-vm;hpb=dd0ff7b7d37f0dcf436cd6921f8ffcaa16332a24

diff --git a/README b/README
index ba6c49c..9610b1c 100644
--- a/README
+++ b/README
@@ -1,63 +1,95 @@
-RFID-Biblio
+NAME
+    Biblio::RFID - perl tools to use different RFID readers for library use
 
-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.
+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 Biblio::RFID::Reader.
 
-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 to get an idea of the module's 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.
+    Writing support for new RFID readers should be easy.
+    Biblio::RFID::Reader::API provides documentation on writing support for
+    different readers.
 
+    Currently, two serial RFID readers based on Biblio::RFID::Reader::Serial
+    are implemented:
 
-INSTALLATION
+    *   Biblio::RFID::Reader::3M810
 
-To install this module, run the following commands:
+    *   Biblio::RFID::Reader::CPRM02
 
-	perl Makefile.PL
-	make
-	make test
-	make install
+    There is also simple read-only reader using shell commands in
+    Biblio::RFID::Reader::librfid.
 
-SUPPORT AND DOCUMENTATION
+    For implementing application take a look at Biblio::RFID::Reader
 
-After installing, you can find documentation for this module with the
-perldoc command.
+    `scripts/RFID-JSONP-server.pl' is example of such application. It's
+    local interface to RFID reader and JSONP REST server.
 
-    perldoc RFID::Biblio
+    `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.
 
-You can also look for information at:
+    Applications can use Biblio::RFID::RFID501 which is some kind of
+    semi-standard 3M layout or blocks on RFID tags.
 
-    RT, CPAN's request tracker
-        http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Biblio
+HARDWARE SUPPORT
+  3M 810
+    Biblio::RFID::Reader::3M810
 
-    AnnoCPAN, Annotated CPAN documentation
-        http://annocpan.org/dist/RFID-Biblio
+  CPR-M02
+    Biblio::RFID::Reader::CPRM02
 
-    CPAN Ratings
-        http://cpanratings.perl.org/d/RFID-Biblio
+  librfid
+    Biblio::RFID::Reader::librfid
 
-    Search CPAN
-        http://search.cpan.org/dist/RFID-Biblio/
+AUTHOR
+    Dobrica Pavlinusic, `<dpavlin at rot13.org>'
 
+    http://blog.rot13.org/
 
-LICENSE AND COPYRIGHT
+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=Biblio-RFID. I will be
+    notified, and then you'll automatically be notified of progress on your
+    bug as I make changes.
+
+SUPPORT
+    You can find documentation for this module with the perldoc command.
+
+        perldoc Biblio::RFID
+        perldoc Biblio::RFID::Reader
+        perldoc Biblio::RFID::Reader::API
+
+    You can also look for information at:
+
+    * RT: CPAN's request tracker
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Biblio-RFID
 
-Copyright (C) 2010 Dobrica Pavlinusic
+    * AnnoCPAN: Annotated CPAN documentation
+        http://annocpan.org/dist/Biblio-RFID
+
+    * CPAN Ratings
+        http://cpanratings.perl.org/d/Biblio-RFID
+
+    * Search CPAN
+        http://search.cpan.org/dist/Biblio-RFID/
+
+ACKNOWLEDGEMENTS
+LICENSE AND COPYRIGHT
+    Copyright 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.