Added project README
This commit is contained in:
parent
c2807987b8
commit
e9e669b4c2
22
README.md
Normal file
22
README.md
Normal file
@ -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_
|
Loading…
Reference in New Issue
Block a user