From e9e669b4c29fd23298d45c84e3867b22040c1934 Mon Sep 17 00:00:00 2001 From: TJ Woon Date: Thu, 11 Sep 2014 15:51:43 +0800 Subject: [PATCH] Added project README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c8c25d2 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ZBar Barcode Scanner Plugin + +This plugin integrates with the [ZBar](http://zbar.sourceforge.net/) library, +exposing a JavaScript interface for scanning barcodes (QR, 2D, etc). + +## API + +### Scan barcode + + cloudSky.zBar.scan(params, onSuccess, onFailure) + +Arguments: + +- **params**: _Unused for now. Will be an object in the future if we extend this plugin with options to specify scannable barcode types, etc._ +- **onSuccess**: function (s) {...} _Callback for successful scan._ +- **onFailure**: function (s) {...} _Callback for cancelled scan or error._ + +Return: + +- success('scanned bar code') _Successful scan with value of scanned code_ +- error('cancelled') _If user cancelled the scan (with back button etc)_ +- error('misc error message') _Misc failure_