28ee13e4f4a3111e49ee8e5525ee26e1a0463801
[Biblio-RFID.git] / README
1 NAME
2     RFID::Biblio - perl tools to use different RFID readers for library use
3
4 DESCRIPTION
5     Main idea is to develop simple API to reader, and than provide useful
6     abstractions on top of it to quickly write applications to respond on
7     tags which come in range of RFID reader using RFID::Biblio::Reader.
8
9     Writing support for new RFID readers should be easy.
10     RFID::Biblio::Reader::API provides documentation on writing support for
11     different readers.
12
13     Currently, two serial RFID readers based on RFID::Biblio::Reader::Serial
14     are implemented:
15
16     *   RFID::Biblio::Reader::3M810
17
18     *   RFID::Biblio::Reader::CPRM02
19
20     There is also simple read-only reader using shell commands in
21     RFID::Biblio::Reader::librfid.
22
23     For implementing application take a look at RFID::Biblio::Reader
24
25     `scripts/RFID-JSONP-server.pl' is example of such application. It's
26     local interface to RFID reader and JSONP REST server.
27
28     `examples/koha-rfid.js' is jQuery based JavaScript code which can be
29     inserted in Koha Library System to provide overlay with tags in range
30     and check-in/check-out form-fill functionality.
31
32 HARDWARE SUPPORT
33   3M 810
34     RFID::Biblio::Reader::3M810
35
36   CPR-M02
37     RFID::Biblio::Reader::CPRM02
38
39   librfid
40     RFID::Biblio::Reader::librfid
41
42 AUTHOR
43     Dobrica Pavlinusic, `<dpavlin at rot13.org>'
44
45 BUGS
46     Please report any bugs or feature requests to `bug-rfid-biblio at
47     rt.cpan.org', or through the web interface at
48     http://rt.cpan.org/NoAuth/ReportBug.html?Queue=RFID-Biblio. I will be
49     notified, and then you'll automatically be notified of progress on your
50     bug as I make changes.
51
52 SUPPORT
53     You can find documentation for this module with the perldoc command.
54
55         perldoc RFID::Biblio
56         perldoc RFID::Biblio::Reader
57         perldoc RFID::Biblio::Reader::API
58
59     You can also look for information at:
60
61     * RT: CPAN's request tracker
62         http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Biblio
63
64     * AnnoCPAN: Annotated CPAN documentation
65         http://annocpan.org/dist/RFID-Biblio
66
67     * CPAN Ratings
68         http://cpanratings.perl.org/d/RFID-Biblio
69
70     * Search CPAN
71         http://search.cpan.org/dist/RFID-Biblio/
72
73 ACKNOWLEDGEMENTS
74 LICENSE AND COPYRIGHT
75     Copyright 2010 Dobrica Pavlinusic.
76
77     This program is free software; you can redistribute it and/or modify it
78     under the terms of the GNU General Public License as published by the
79     Free Software Foundation; version 2 dated June, 1991 or at your option
80     any later version.
81
82     This program is distributed in the hope that it will be useful, but
83     WITHOUT ANY WARRANTY; without even the implied warranty of
84     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
85     Public License for more details.
86
87     A copy of the GNU General Public License is available in the source
88     tree; if not, write to the Free Software Foundation, Inc., 59 Temple
89     Place - Suite 330, Boston, MA 02111-1307, USA.
90