diff --git a/qractivity/README.md b/qractivity/README.md index cadec4a..4705220 100644 --- a/qractivity/README.md +++ b/qractivity/README.md @@ -10,6 +10,12 @@ Say hi to QRActivity! A customizable, pre-built activity ready to launch and rea * **Fast:** You can expect it to lauch, read the QR and return the result within a second * **Customizable:** Restrict image picker usage, autofocus interval, toggle fullscreen and more +## Demo Video +Click on the thumbnail below to watch demo video + + + ## Installation ### Gradle @@ -84,6 +90,25 @@ startActivityForResult( } ``` +## Methods and functions + +### Building + +```java +setImagePickerEnabled(boolean imagePickerEnabled) // enables/disables the use of image picker for reading QRs from image files +setFullScreen(boolean fullScreen) // hides the status bar in QRActivity if true +setAutoFocusInterval(long interval) // sets the auto focus interval in QR scanner +setFocusOnTouchEnabled(boolean focusOnTouch) // decides if QR scanner should focus on tap (may not work on all devices) +build() // builds the QR scanner and returns as an Intent (required) +``` + +### Getting the result + +```java +String qrData = data.getStringExtra("qrData"); // getting scanned QR data +String error = data.getStringExtra("error"); // getting the error message (in case one occurs) +``` + ## Release History * 0.1.0