Olaf Görlitz

added description of all examples to examples README

@@ -2,15 +2,66 @@ @@ -2,15 +2,66 @@
2 2
3 Demonstrates how to use the mobile_scanner plugin. 3 Demonstrates how to use the mobile_scanner plugin.
4 4
5 -## Getting Started 5 +## Run Examples
6 6
7 -This project is a starting point for a Flutter application. 7 +1. `git clone https://github.com/juliansteenbakker/mobile_scanner.git`
  8 +2. `cd mobile_scanner/examples/lib`
  9 +3. `flutter pub get`
  10 +4. `flutter run`
8 11
9 -A few resources to get you started if this is your first Flutter project: 12 +## Examples Overview
10 13
11 -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)  
12 -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) 14 +### With Controller
13 15
14 -For help getting started with Flutter development, view the  
15 -[online documentation](https://docs.flutter.dev/), which offers tutorials,  
16 -samples, guidance on mobile development, and a full API reference. 16 +Scanner widget with control buttons overlay. Shows first detected barcode.
  17 +(See ListView example for detecting and displaying multiple barcodes at the same time.)
  18 +
  19 +* Displays Flashlight, SwitchCamera and Start/Stop buttons.
  20 +* Uses `MobileScannerController` to start/stop, toggle flashlight, switch camera.
  21 +* Displays Gallery button to use images as source for analysis.
  22 +* Handles changes in AppLifecycleState.
  23 +
  24 +### With ListView
  25 +
  26 +Scanner widget with control buttons overlay. Shows all barcodes detected at the same time in a ListView.
  27 +
  28 +* Displays Flashlight, SwitchCamera and Start/Stop buttons.
  29 +* Uses `MobileScannerController` to start/stop, toggle flashlight, switch camera.
  30 +* Displays Gallery button to use images as source for analysis.
  31 +
  32 +### With Zoom Slider
  33 +
  34 +Scanner widget with control buttons and zoom slider overlay. Shows first detected barcode.
  35 +
  36 +* Displays Flashlight, SwitchCamera and Start/Stop buttons and zoom slider.
  37 +* Uses `MobileScannerController` to start/stop, toggle flashlight, switch camera, set zoom scale.
  38 +* Displays Gallery button to use images as source for analysis.
  39 +
  40 +### With Controller (returning image)
  41 +
  42 +Scanner widget with control buttons overlay. Shows the first detected barcode and the captured image.
  43 +
  44 +* Displays Flashlight, SwitchCamera and Start/Stop buttons.
  45 +* Uses `MobileScannerController` to start/stop, toggle flashlight, switch camera.
  46 +* Displays captured image that contains the detected barcode.
  47 +
  48 +### With Page View
  49 +
  50 +Scanner widget in one of many pages that can be swiped horizontally. Starts and stops scanner depending on page visibility.
  51 +
  52 +* Shows first detected barcode.
  53 +
  54 +### With Scan Window
  55 +
  56 +Scanner widget with scan window overlay. Barcodes are only detected inside the scan window.
  57 +
  58 +* Draws scan window - a half-transparent overlay with a cut out middle part.
  59 +* Draws bounding box around (first) detected barcode. (not working on every device)
  60 +
  61 +### With Overlay
  62 +
  63 +Scanner widget with scan window overlay. Barcodes are only detected inside the scan window.
  64 +
  65 +* Draws scan window - a half-transparent overlay with a cut out middle part that has a border with rounded corners.
  66 +* Displays Flashlight, SwitchCamera buttons.
  67 +* Uses `MobileScannerController` to toggle flashlight, switch camera.