diff --git a/README.md b/README.md index 0bb1d29..4155e14 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ ## BarcodeScanTorch -[Barcode scanner with torch functionality] - -## Features -[feature highlights] +Mendix Native Barcode scanner with torch functionality ## Usage -[step by step instructions] +For development: +- Create customwidgets folder in root of project directory +- Git clone this repo into customwidgets folder +- Open command prompt in cloned folder +- npm i +- npm i react-native-camera +- npm run dev / npm run build + +Widget can now be used inside Mendix. + +For plain usage: +- Copy MPK file in releases to widgets directory. ## Demo project -[link to sandbox] +Not available yet. ## Issues, suggestions and feature requests -[link to GitHub issues] +https://github.com/IncentroBA/barcodescantorch/issues ## Development and contribution -[specify contribute] +- Based on https://github.com/mendix/native-mobile-resources