From f3bec118ff80fb93f6ccb488e5208ceb8b9f38cb Mon Sep 17 00:00:00 2001
From: Kholofelo Moyaba <kmmoyaba@gmail.com>
Date: Sun, 24 Nov 2019 05:20:53 +0200
Subject: [PATCH] feat: initial commit with readme

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4168f43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Flutter Scandit
+
+Flutter Plugin for [Scandit](https://www.scandit.com/) Barcode Scanning
+
+## Getting Started
+
+This project is a starting point for a Flutter
+[plug-in package](https://flutter.dev/developing-packages/),
+a specialized package that includes platform-specific implementation code for
+Android and/or iOS.
+
+For help getting started with Flutter, view our 
+[online documentation](https://flutter.dev/docs), which offers tutorials, 
+samples, guidance on mobile development, and a full API reference.
+
+## Features:
+
+* Scan a barcode on demand
+
+## Installation
+
+First, add `flutter_scandit` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
+
+### iOS
+
+Add the following to the `ios/Runner/Info.plist`:
+
+* The key `Privacy - Camera Usage Description` and a usage description.
+
+Or in text format add the key:
+
+```xml
+<key>NSCameraUsageDescription</key>
+<string>Can I use the camera for scanning?</string>
+```
+Min target is iOS 9.0
+
+
+### Android
+
+Min SDK version should be 19 or later
+
+```
+minSdkVersion 19
+```
+
+### Example
+
+An exmaple with specific symbologies
+```dart
+BarcodeResult result = await FlutterScandit(symbologies: [
+  Symbology.EAN13_UPCA,
+  Symbology.CODE128,
+  // - any other valid sumbologies
+], licenseKey: "-- ENTER YOUR SCANDIT LICENSE KEY HERE -")
+    .scanBarcode();
+setState(() {
+  barcode = result;
+});
+```
+
+You should always pass the intended symbologies along with your call. It is also important to check that the symbologies you are selecting align with your Scandit license restrictions.
+
+Since the actual keys will be different per platoform, it is advised to abtract this out using environment variables or global configuration that can be changed per build/environment.
+