X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=README;h=3e9e5edb5c1e0cc74159074da752b59ff23441a8;hb=becb8bf3849f1013fe2d1f7e9c2efbaa1d6461a9;hp=6ba324cb4dcc467276d5ff97d8c23feb437d15f2;hpb=d4c2be7da6dd8fd4365b4b51eaacbcf898d110af;p=Biblio-RFID.git diff --git a/README b/README index 6ba324c..3e9e5ed 100644 --- a/README +++ b/README @@ -1,15 +1,25 @@ -RFID-Serial +RFID-Biblio -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 is set of tools to use different RFID readers for library use. -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. +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. + +scripts/RFID-JSONP-server.pl is example of such application. It's local +interface to RFID reader and JSONP REST server. + +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. + +Currently supported readers: + + * 3M 810 - RFID::Biblio::Reader::3M810 + * CPR-M02 - RFID::Biblio::Reader::CPRM02 + * OpenPCD, The Omnikey CardMan 5121 and 5321 - RFID::Biblio::Reader::librfid + +For status of each implementation see pod documentation inside them. INSTALLATION @@ -26,21 +36,21 @@ SUPPORT AND DOCUMENTATION After installing, you can find documentation for this module with the perldoc command. - perldoc RFID::Serial + perldoc RFID::Biblio You can also look for information at: RT, CPAN's request tracker - http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Serial + http://rt.cpan.org/NoAuth/Bugs.html?Dist=RFID-Biblio AnnoCPAN, Annotated CPAN documentation - http://annocpan.org/dist/RFID-Serial + http://annocpan.org/dist/RFID-Biblio CPAN Ratings - http://cpanratings.perl.org/d/RFID-Serial + http://cpanratings.perl.org/d/RFID-Biblio Search CPAN - http://search.cpan.org/dist/RFID-Serial/ + http://search.cpan.org/dist/RFID-Biblio/ LICENSE AND COPYRIGHT